socketvar.h revision 154294
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 154294 2006-01-13 10:22:01Z 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. 58131168Srwatson * (h) locked by global mutex so_global_mtx. 5995552Stanimura */ 601541Srgrimesstruct socket { 61130387Srwatson int so_count; /* (b) reference count */ 62129958Srwatson short so_type; /* (a) generic type, see socket.h */ 6397658Stanimura short so_options; /* from socket call, see socket.h */ 6497658Stanimura short so_linger; /* time to linger while closing */ 65130818Srwatson short so_state; /* (b) internal state flags SS_* */ 66129979Srwatson int so_qstate; /* (e) internal state flags SQ_* */ 6798993Salfred void *so_pcb; /* protocol control block */ 68129958Srwatson struct protosw *so_proto; /* (a) protocol handle */ 691541Srgrimes/* 7013765Smpp * Variables for connection queuing. 711541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets. 721541Srgrimes * If so_head is 0, socket is not related to an accept. 7378913Sjlemon * For head socket so_incomp queues partially completed connections, 7478913Sjlemon * while so_comp is a queue of connections ready to be accepted. 751541Srgrimes * If a connection is aborted and it has so_head set, then 7678913Sjlemon * it has to be pulled out of either so_incomp or so_comp. 771541Srgrimes * We allow connections to queue up based on current queue lengths 781541Srgrimes * and limit on number of queued connections for this socket. 791541Srgrimes */ 80129979Srwatson struct socket *so_head; /* (e) back pointer to accept socket */ 81129979Srwatson TAILQ_HEAD(, socket) so_incomp; /* (e) queue of partial unaccepted connections */ 82129979Srwatson TAILQ_HEAD(, socket) so_comp; /* (e) queue of complete unaccepted connections */ 83129979Srwatson TAILQ_ENTRY(socket) so_list; /* (e) list of unaccepted connections */ 84140730Sglebius u_short so_qlen; /* (e) number of unaccepted connections */ 85140730Sglebius u_short so_incqlen; /* (e) number of unaccepted incomplete 8618787Spst connections */ 87140730Sglebius u_short so_qlimit; /* (e) max number queued connections */ 88130527Srwatson short so_timeo; /* (g) connection timeout */ 89131029Srwatson u_short so_error; /* (f) error affecting connection */ 9097658Stanimura struct sigio *so_sigio; /* [sg] information for async I/O or 9141087Struckman out of band data (SIGURG) */ 92131017Srwatson u_long so_oobmark; /* (c) chars to oob mark */ 9397658Stanimura TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ 941541Srgrimes/* 951541Srgrimes * Variables for socket buffering. 961541Srgrimes */ 9783421Sobrien struct sockbuf { 98100591Sjdp struct selinfo sb_sel; /* process selecting read/write */ 99130380Srwatson struct mtx sb_mtx; /* sockbuf lock */ 100141052Sglebius short sb_state; /* (c/d) socket state on sockbuf */ 101117708Srobert#define sb_startzero sb_mb 102130527Srwatson struct mbuf *sb_mb; /* (c/d) the mbuf chain */ 103130527Srwatson struct mbuf *sb_mbtail; /* (c/d) the last mbuf in the chain */ 104130527Srwatson struct mbuf *sb_lastrecord; /* (c/d) first mbuf of last 105130527Srwatson * record in socket buffer */ 106130527Srwatson u_int sb_cc; /* (c/d) actual chars in buffer */ 107130527Srwatson u_int sb_hiwat; /* (c/d) max actual char count */ 108130527Srwatson u_int sb_mbcnt; /* (c/d) chars of mbufs used */ 109130527Srwatson u_int sb_mbmax; /* (c/d) max chars of mbufs to use */ 110130527Srwatson u_int sb_ctl; /* (c/d) non-data chars in buffer */ 111130527Srwatson int sb_lowat; /* (c/d) low water mark */ 112130527Srwatson int sb_timeo; /* (c/d) timeout for read/write */ 113130527Srwatson short sb_flags; /* (c/d) flags, see below */ 1141541Srgrimes } so_rcv, so_snd; 115130818Srwatson/* 116130818Srwatson * Constants for sb_flags field of struct sockbuf. 117130818Srwatson */ 1181541Srgrimes#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 119131022Srwatson/* 120131022Srwatson * Constants for sb_flags field of struct sockbuf. 121131022Srwatson */ 1221541Srgrimes#define SB_LOCK 0x01 /* lock on data queue */ 1231541Srgrimes#define SB_WANT 0x02 /* someone is waiting to lock */ 1241541Srgrimes#define SB_WAIT 0x04 /* someone is waiting for data/space */ 1251541Srgrimes#define SB_SEL 0x08 /* someone is selecting */ 1261541Srgrimes#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 12736527Speter#define SB_UPCALL 0x20 /* someone wants an upcall */ 1281541Srgrimes#define SB_NOINTR 0x40 /* operations not interruptible */ 12955943Sjasone#define SB_AIO 0x80 /* AIO operations queued */ 13059288Sjlemon#define SB_KNOTE 0x100 /* kernel note attached */ 1311541Srgrimes 13297658Stanimura void (*so_upcall)(struct socket *, void *, int); 13397658Stanimura void *so_upcallarg; 134130527Srwatson struct ucred *so_cred; /* (a) user credentials */ 135130398Srwatson struct label *so_label; /* (b) MAC label for socket */ 136130398Srwatson struct label *so_peerlabel; /* (b) cached MAC label for peer */ 13738482Swollman /* NB: generation count must not be first; easiest to make it last. */ 138131168Srwatson so_gen_t so_gencnt; /* (h) generation count */ 139147852Sjhb void *so_emuldata; /* (b) private data for emulators */ 14097658Stanimura struct so_accf { 14197658Stanimura struct accept_filter *so_accept_filter; 14297658Stanimura void *so_accept_filter_arg; /* saved filter args */ 14397658Stanimura char *so_accept_filter_str; /* saved user args */ 14497658Stanimura } *so_accf; 1451541Srgrimes}; 1461541Srgrimes 147121628Ssam#define SB_EMPTY_FIXUP(sb) do { \ 148121628Ssam if ((sb)->sb_mb == NULL) { \ 149121628Ssam (sb)->sb_mbtail = NULL; \ 150121628Ssam (sb)->sb_lastrecord = NULL; \ 151121628Ssam } \ 152121628Ssam} while (/*CONSTCOND*/0) 153121628Ssam 1541541Srgrimes/* 155129979Srwatson * Global accept mutex to serialize access to accept queues and 156129979Srwatson * fields associated with multiple sockets. This allows us to 157129979Srwatson * avoid defining a lock order between listen and accept sockets 158129979Srwatson * until such time as it proves to be a good idea. 159129979Srwatson */ 160129979Srwatsonextern struct mtx accept_mtx; 161136682Srwatson#define ACCEPT_LOCK_ASSERT() mtx_assert(&accept_mtx, MA_OWNED) 162136682Srwatson#define ACCEPT_UNLOCK_ASSERT() mtx_assert(&accept_mtx, MA_NOTOWNED) 163130364Srwatson#define ACCEPT_LOCK() mtx_lock(&accept_mtx) 164130364Srwatson#define ACCEPT_UNLOCK() mtx_unlock(&accept_mtx) 165129979Srwatson 166129979Srwatson/* 167130380Srwatson * Per-socket buffer mutex used to protect most fields in the socket 168130380Srwatson * buffer. 169130380Srwatson */ 170130380Srwatson#define SOCKBUF_MTX(_sb) (&(_sb)->sb_mtx) 171130380Srwatson#define SOCKBUF_LOCK_INIT(_sb, _name) \ 172130380Srwatson mtx_init(SOCKBUF_MTX(_sb), _name, NULL, MTX_DEF) 173130380Srwatson#define SOCKBUF_LOCK_DESTROY(_sb) mtx_destroy(SOCKBUF_MTX(_sb)) 174130380Srwatson#define SOCKBUF_LOCK(_sb) mtx_lock(SOCKBUF_MTX(_sb)) 175130380Srwatson#define SOCKBUF_OWNED(_sb) mtx_owned(SOCKBUF_MTX(_sb)) 176130380Srwatson#define SOCKBUF_UNLOCK(_sb) mtx_unlock(SOCKBUF_MTX(_sb)) 177130380Srwatson#define SOCKBUF_LOCK_ASSERT(_sb) mtx_assert(SOCKBUF_MTX(_sb), MA_OWNED) 178136326Srwatson#define SOCKBUF_UNLOCK_ASSERT(_sb) mtx_assert(SOCKBUF_MTX(_sb), MA_NOTOWNED) 179130380Srwatson 180130380Srwatson/* 181130380Srwatson * Per-socket mutex: we reuse the receive socket buffer mutex for space 182130380Srwatson * efficiency. This decision should probably be revisited as we optimize 183130380Srwatson * locking for the socket code. 184130380Srwatson */ 185130380Srwatson#define SOCK_MTX(_so) SOCKBUF_MTX(&(_so)->so_rcv) 186130380Srwatson#define SOCK_LOCK(_so) SOCKBUF_LOCK(&(_so)->so_rcv) 187130380Srwatson#define SOCK_OWNED(_so) SOCKBUF_OWNED(&(_so)->so_rcv) 188130380Srwatson#define SOCK_UNLOCK(_so) SOCKBUF_UNLOCK(&(_so)->so_rcv) 189130380Srwatson#define SOCK_LOCK_ASSERT(_so) SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv) 190130380Srwatson 191130492Srwatson/* 1921541Srgrimes * Socket state bits. 193130480Srwatson * 194130480Srwatson * Historically, this bits were all kept in the so_state field. For 195130480Srwatson * locking reasons, they are now in multiple fields, as they are 196130480Srwatson * locked differently. so_state maintains basic socket state protected 197130480Srwatson * by the socket lock. so_qstate holds information about the socket 198130480Srwatson * accept queues. Each socket buffer also has a state field holding 199130480Srwatson * information relevant to that socket buffer (can't send, rcv). Many 200130480Srwatson * fields will be read without locks to improve performance and avoid 201130480Srwatson * lock order issues. However, this approach must be used with caution. 2021541Srgrimes */ 20314547Sdg#define SS_NOFDREF 0x0001 /* no file table ref any more */ 20414547Sdg#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 20514547Sdg#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 20614547Sdg#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 20714547Sdg#define SS_NBIO 0x0100 /* non-blocking ops */ 20814547Sdg#define SS_ASYNC 0x0200 /* async i/o notify */ 20914547Sdg#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 21043196Sfenner#define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */ 2111541Srgrimes 21236079Swollman/* 213130480Srwatson * Socket state bits now stored in the socket buffer state field. 214130480Srwatson */ 215130480Srwatson#define SBS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 216130480Srwatson#define SBS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 217130480Srwatson#define SBS_RCVATMARK 0x0040 /* at mark on input */ 218130480Srwatson 219130480Srwatson/* 220129916Srwatson * Socket state bits stored in so_qstate. 221129916Srwatson */ 222129916Srwatson#define SQ_INCOMP 0x0800 /* unaccepted, incomplete connection */ 223129916Srwatson#define SQ_COMP 0x1000 /* unaccepted, complete connection */ 224129916Srwatson 225129916Srwatson/* 22636079Swollman * Externalized form of struct socket used by the sysctl(3) interface. 22736079Swollman */ 22883045Sobrienstruct xsocket { 22936079Swollman size_t xso_len; /* length of this structure */ 23036079Swollman struct socket *xso_so; /* makes a convenient handle sometimes */ 23136079Swollman short so_type; 23236079Swollman short so_options; 23336079Swollman short so_linger; 23436079Swollman short so_state; 23536079Swollman caddr_t so_pcb; /* another convenient handle */ 23636079Swollman int xso_protocol; 23736079Swollman int xso_family; 238140730Sglebius u_short so_qlen; 239140730Sglebius u_short so_incqlen; 240140730Sglebius u_short so_qlimit; 24136079Swollman short so_timeo; 24236079Swollman u_short so_error; 24336079Swollman pid_t so_pgid; 24436079Swollman u_long so_oobmark; 24583421Sobrien struct xsockbuf { 246100591Sjdp u_int sb_cc; 247100591Sjdp u_int sb_hiwat; 248100591Sjdp u_int sb_mbcnt; 249100591Sjdp u_int sb_mbmax; 250100591Sjdp int sb_lowat; 251100591Sjdp int sb_timeo; 25236079Swollman short sb_flags; 25336079Swollman } so_rcv, so_snd; 25436079Swollman uid_t so_uid; /* XXX */ 25536079Swollman}; 25614547Sdg 257130393Srwatson#ifdef _KERNEL 258130393Srwatson 2591541Srgrimes/* 2601541Srgrimes * Macros for sockets and socket buffering. 2611541Srgrimes */ 2621541Srgrimes 2631541Srgrimes/* 26436527Speter * Do we need to notify the other side when I/O is possible? 26536527Speter */ 26655943Sjasone#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \ 26759288Sjlemon SB_UPCALL | SB_AIO | SB_KNOTE)) != 0) 26836527Speter 26936527Speter/* 2701541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 2711541Srgrimes * This is problematical if the fields are unsigned, as the space might 2721541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 2731541Srgrimes * overflow and return 0. Should use "lmin" but it doesn't exist now. 2741541Srgrimes */ 2751541Srgrimes#define sbspace(sb) \ 2761541Srgrimes ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 2771541Srgrimes (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 2781541Srgrimes 2791541Srgrimes/* do we have to send all at once on a socket? */ 2801541Srgrimes#define sosendallatonce(so) \ 2811541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 2821541Srgrimes 2831541Srgrimes/* can we read something from so? */ 2841541Srgrimes#define soreadable(so) \ 2851541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 286130480Srwatson ((so)->so_rcv.sb_state & SBS_CANTRCVMORE) || \ 28770536Sphk !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error) 2881541Srgrimes 2891541Srgrimes/* can we write something to so? */ 2901541Srgrimes#define sowriteable(so) \ 2913304Sphk ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 2921541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 2933304Sphk ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 294130480Srwatson ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \ 2951541Srgrimes (so)->so_error) 2961541Srgrimes 2971541Srgrimes/* adjust counters in sb reflecting allocation of m */ 2981541Srgrimes#define sballoc(sb, m) { \ 2991541Srgrimes (sb)->sb_cc += (m)->m_len; \ 300151967Sandre if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \ 301106313Skbyanc (sb)->sb_ctl += (m)->m_len; \ 3021541Srgrimes (sb)->sb_mbcnt += MSIZE; \ 3031541Srgrimes if ((m)->m_flags & M_EXT) \ 3041541Srgrimes (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 3051541Srgrimes} 3061541Srgrimes 3071541Srgrimes/* adjust counters in sb reflecting freeing of m */ 3081541Srgrimes#define sbfree(sb, m) { \ 3091541Srgrimes (sb)->sb_cc -= (m)->m_len; \ 310151967Sandre if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \ 311106313Skbyanc (sb)->sb_ctl -= (m)->m_len; \ 3121541Srgrimes (sb)->sb_mbcnt -= MSIZE; \ 3131541Srgrimes if ((m)->m_flags & M_EXT) \ 3141541Srgrimes (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 3151541Srgrimes} 3161541Srgrimes 3171541Srgrimes/* 3181541Srgrimes * Set lock on sockbuf sb; sleep if lock is already held. 3191541Srgrimes * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 3201541Srgrimes * Returns error without lock if sleep is interrupted. 3211541Srgrimes */ 3221541Srgrimes#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 323111119Simp (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 3241541Srgrimes ((sb)->sb_flags |= SB_LOCK), 0) 3251541Srgrimes 3261541Srgrimes/* release lock on sockbuf sb */ 327130831Srwatson#define sbunlock(sb) do { \ 328130831Srwatson SOCKBUF_LOCK_ASSERT(sb); \ 3291541Srgrimes (sb)->sb_flags &= ~SB_LOCK; \ 3301541Srgrimes if ((sb)->sb_flags & SB_WANT) { \ 3311541Srgrimes (sb)->sb_flags &= ~SB_WANT; \ 332111748Sdes wakeup(&(sb)->sb_flags); \ 3331541Srgrimes } \ 334130831Srwatson} while (0) 3351541Srgrimes 33686487Sdillon/* 33786487Sdillon * soref()/sorele() ref-count the socket structure. Note that you must 33886487Sdillon * still explicitly close the socket, but the last ref count will free 33986487Sdillon * the structure. 34086487Sdillon */ 341130383Srwatson#define soref(so) do { \ 342130387Srwatson SOCK_LOCK_ASSERT(so); \ 343130383Srwatson ++(so)->so_count; \ 344130383Srwatson} while (0) 34586487Sdillon 346130383Srwatson#define sorele(so) do { \ 347136682Srwatson ACCEPT_LOCK_ASSERT(); \ 348130387Srwatson SOCK_LOCK_ASSERT(so); \ 349130383Srwatson if ((so)->so_count <= 0) \ 350130383Srwatson panic("sorele"); \ 351130383Srwatson if (--(so)->so_count == 0) \ 352130383Srwatson sofree(so); \ 353136682Srwatson else { \ 354130387Srwatson SOCK_UNLOCK(so); \ 355136682Srwatson ACCEPT_UNLOCK(); \ 356136682Srwatson } \ 357130383Srwatson} while (0) 35886487Sdillon 359130383Srwatson#define sotryfree(so) do { \ 360136682Srwatson ACCEPT_LOCK_ASSERT(); \ 361130387Srwatson SOCK_LOCK_ASSERT(so); \ 362130383Srwatson if ((so)->so_count == 0) \ 363130383Srwatson sofree(so); \ 364136682Srwatson else { \ 365130387Srwatson SOCK_UNLOCK(so); \ 366136682Srwatson ACCEPT_UNLOCK(); \ 367136682Srwatson } \ 368130383Srwatson} while(0) 36986487Sdillon 370130831Srwatson/* 371130831Srwatson * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to 372130831Srwatson * avoid a non-atomic test-and-wakeup. However, sowakeup is 373130831Srwatson * responsible for releasing the lock if it is called. We unlock only 374130831Srwatson * if we don't call into sowakeup. If any code is introduced that 375130831Srwatson * directly invokes the underlying sowakeup() primitives, it must 376130831Srwatson * maintain the same semantics. 377130831Srwatson */ 378130831Srwatson#define sorwakeup_locked(so) do { \ 379130831Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_rcv); \ 380130383Srwatson if (sb_notify(&(so)->so_rcv)) \ 381130831Srwatson sowakeup((so), &(so)->so_rcv); \ 382130831Srwatson else \ 383130831Srwatson SOCKBUF_UNLOCK(&(so)->so_rcv); \ 384130383Srwatson} while (0) 3851541Srgrimes 386130831Srwatson#define sorwakeup(so) do { \ 387130831Srwatson SOCKBUF_LOCK(&(so)->so_rcv); \ 388130831Srwatson sorwakeup_locked(so); \ 389130831Srwatson} while (0) 390130831Srwatson 391130831Srwatson#define sowwakeup_locked(so) do { \ 392131029Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_snd); \ 393130383Srwatson if (sb_notify(&(so)->so_snd)) \ 394130383Srwatson sowakeup((so), &(so)->so_snd); \ 395130831Srwatson else \ 396130831Srwatson SOCKBUF_UNLOCK(&(so)->so_snd); \ 397130383Srwatson} while (0) 3981541Srgrimes 399130831Srwatson#define sowwakeup(so) do { \ 400130831Srwatson SOCKBUF_LOCK(&(so)->so_snd); \ 401130831Srwatson sowwakeup_locked(so); \ 402130831Srwatson} while (0) 403130831Srwatson 40438482Swollman/* 40538482Swollman * Argument structure for sosetopt et seq. This is in the KERNEL 40638482Swollman * section because it will never be visible to user code. 40738482Swollman */ 40838482Swollmanenum sopt_dir { SOPT_GET, SOPT_SET }; 40938482Swollmanstruct sockopt { 41038482Swollman enum sopt_dir sopt_dir; /* is this a get or a set? */ 41138482Swollman int sopt_level; /* second arg of [gs]etsockopt */ 41238482Swollman int sopt_name; /* third arg of [gs]etsockopt */ 41338482Swollman void *sopt_val; /* fourth arg of [gs]etsockopt */ 41438482Swollman size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */ 41595959Salfred struct thread *sopt_td; /* calling thread or null if kernel */ 41638482Swollman}; 41738482Swollman 41861837Salfredstruct accept_filter { 41961837Salfred char accf_name[16]; 42061837Salfred void (*accf_callback) 42192719Salfred (struct socket *so, void *arg, int waitflag); 42261837Salfred void * (*accf_create) 42392719Salfred (struct socket *so, char *arg); 42461837Salfred void (*accf_destroy) 42592719Salfred (struct socket *so); 42695959Salfred SLIST_ENTRY(accept_filter) accf_next; 42782656Sjlemon}; 42861837Salfred 42931927Sbde#ifdef MALLOC_DECLARE 43095959SalfredMALLOC_DECLARE(M_ACCF); 43131927SbdeMALLOC_DECLARE(M_PCB); 43231927SbdeMALLOC_DECLARE(M_SONAME); 43331927Sbde#endif 43431927Sbde 43595959Salfredextern int maxsockets; 4362112Swollmanextern u_long sb_max; 43795959Salfredextern struct uma_zone *socket_zone; 43836079Swollmanextern so_gen_t so_gencnt; 43914505Shsu 44015492Sbdestruct mbuf; 44115492Sbdestruct sockaddr; 44232995Sbdestruct ucred; 44332995Sbdestruct uio; 44415492Sbde 4451541Srgrimes/* 4463304Sphk * From uipc_socket and friends 4473304Sphk */ 448143463Srwatsonint do_getopt_accept_filter(struct socket *so, struct sockopt *sopt); 449142058Srwatsonint do_setopt_accept_filter(struct socket *so, struct sockopt *sopt); 450132060Sdwmaloneint so_setsockopt(struct socket *so, int level, int optname, 451132060Sdwmalone void *optval, size_t optlen); 45292719Salfredint sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type); 45392719Salfredint getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len); 45492719Salfredvoid sbappend(struct sockbuf *sb, struct mbuf *m); 455130831Srwatsonvoid sbappend_locked(struct sockbuf *sb, struct mbuf *m); 456121628Ssamvoid sbappendstream(struct sockbuf *sb, struct mbuf *m); 457130831Srwatsonvoid sbappendstream_locked(struct sockbuf *sb, struct mbuf *m); 458130050Srwatsonint sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa, 45992719Salfred struct mbuf *m0, struct mbuf *control); 460130831Srwatsonint sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa, 461130831Srwatson struct mbuf *m0, struct mbuf *control); 46292719Salfredint sbappendcontrol(struct sockbuf *sb, struct mbuf *m0, 46392719Salfred struct mbuf *control); 464130831Srwatsonint sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0, 465130831Srwatson struct mbuf *control); 46692719Salfredvoid sbappendrecord(struct sockbuf *sb, struct mbuf *m0); 467130831Srwatsonvoid sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0); 46892719Salfredvoid sbcheck(struct sockbuf *sb); 46992719Salfredvoid sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n); 47019670Sbdestruct mbuf * 47192719Salfred sbcreatecontrol(caddr_t p, int size, int type, int level); 47292719Salfredvoid sbdrop(struct sockbuf *sb, int len); 473130831Srwatsonvoid sbdrop_locked(struct sockbuf *sb, int len); 47492719Salfredvoid sbdroprecord(struct sockbuf *sb); 475130831Srwatsonvoid sbdroprecord_locked(struct sockbuf *sb); 47692719Salfredvoid sbflush(struct sockbuf *sb); 477130831Srwatsonvoid sbflush_locked(struct sockbuf *sb); 47892719Salfredvoid sbinsertoob(struct sockbuf *sb, struct mbuf *m0); 479130831Srwatsonvoid sbinsertoob_locked(struct sockbuf *sb, struct mbuf *m0); 48092719Salfredvoid sbrelease(struct sockbuf *sb, struct socket *so); 481130831Srwatsonvoid sbrelease_locked(struct sockbuf *sb, struct socket *so); 48292719Salfredint sbreserve(struct sockbuf *sb, u_long cc, struct socket *so, 48393008Sbde struct thread *td); 484131006Srwatsonint sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so, 485131006Srwatson struct thread *td); 48692719Salfredvoid sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb); 48792719Salfredint sbwait(struct sockbuf *sb); 48892719Salfredint sb_lock(struct sockbuf *sb); 48992719Salfredint soabort(struct socket *so); 49092719Salfredint soaccept(struct socket *so, struct sockaddr **nam); 491126411Srwatsonstruct socket *soalloc(int mflags); 49295959Salfredint socheckuid(struct socket *so, uid_t uid); 49392719Salfredint sobind(struct socket *so, struct sockaddr *nam, struct thread *td); 49492719Salfredvoid socantrcvmore(struct socket *so); 495130831Srwatsonvoid socantrcvmore_locked(struct socket *so); 49692719Salfredvoid socantsendmore(struct socket *so); 497130831Srwatsonvoid socantsendmore_locked(struct socket *so); 49892719Salfredint soclose(struct socket *so); 49992719Salfredint soconnect(struct socket *so, struct sockaddr *nam, struct thread *td); 50092719Salfredint soconnect2(struct socket *so1, struct socket *so2); 50198849Skenint socow_setup(struct mbuf *m0, struct uio *uio); 50292719Salfredint socreate(int dom, struct socket **aso, int type, int proto, 50392719Salfred struct ucred *cred, struct thread *td); 504106326Salcvoid sodealloc(struct socket *so); 50592719Salfredint sodisconnect(struct socket *so); 506126425Srwatsonstruct sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags); 50792719Salfredvoid sofree(struct socket *so); 50892719Salfredint sogetopt(struct socket *so, struct sockopt *sopt); 50992719Salfredvoid sohasoutofband(struct socket *so); 51092719Salfredvoid soisconnected(struct socket *so); 51192719Salfredvoid soisconnecting(struct socket *so); 51292719Salfredvoid soisdisconnected(struct socket *so); 51392719Salfredvoid soisdisconnecting(struct socket *so); 51492719Salfredint solisten(struct socket *so, int backlog, struct thread *td); 515151888Srwatsonvoid solisten_proto(struct socket *so, int backlog); 516142190Srwatsonint solisten_proto_check(struct socket *so); 51714505Shsustruct socket * 51892719Salfred sonewconn(struct socket *head, int connstatus); 51993008Sbdeint sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen); 520118453Shsuint sooptcopyout(struct sockopt *sopt, const void *buf, size_t len); 52153541Sshin 52253541Sshin/* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */ 52392719Salfredint soopt_getm(struct sockopt *sopt, struct mbuf **mp); 52492719Salfredint soopt_mcopyin(struct sockopt *sopt, struct mbuf *m); 52592719Salfredint soopt_mcopyout(struct sockopt *sopt, struct mbuf *m); 52653541Sshin 527101983Srwatsonint sopoll(struct socket *so, int events, struct ucred *active_cred, 52893008Sbde struct thread *td); 52993008Sbdeint soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio, 53093008Sbde struct mbuf **mp0, struct mbuf **controlp, int *flagsp); 53192719Salfredint soreserve(struct socket *so, u_long sndcc, u_long rcvcc); 53292719Salfredvoid sorflush(struct socket *so); 53392719Salfredint sosend(struct socket *so, struct sockaddr *addr, struct uio *uio, 53493008Sbde struct mbuf *top, struct mbuf *control, int flags, 53593008Sbde struct thread *td); 536154294Srwatsonint sosend_dgram(struct socket *so, struct sockaddr *addr, 537154294Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 538154294Srwatson int flags, struct thread *td); 53992719Salfredint sosetopt(struct socket *so, struct sockopt *sopt); 54092719Salfredint soshutdown(struct socket *so, int how); 54192719Salfredvoid sotoxsocket(struct socket *so, struct xsocket *xso); 54292719Salfredvoid sowakeup(struct socket *so, struct sockbuf *sb); 54331927Sbde 544121628Ssam#ifdef SOCKBUF_DEBUG 545121628Ssamvoid sblastrecordchk(struct sockbuf *, const char *, int); 546121628Ssam#define SBLASTRECORDCHK(sb) sblastrecordchk((sb), __FILE__, __LINE__) 547121628Ssam 548121628Ssamvoid sblastmbufchk(struct sockbuf *, const char *, int); 549121628Ssam#define SBLASTMBUFCHK(sb) sblastmbufchk((sb), __FILE__, __LINE__) 550121628Ssam#else 551121628Ssam#define SBLASTRECORDCHK(sb) /* nothing */ 552121628Ssam#define SBLASTMBUFCHK(sb) /* nothing */ 553121628Ssam#endif /* SOCKBUF_DEBUG */ 554121628Ssam 55595959Salfred/* 55695959Salfred * Accept filter functions (duh). 55795959Salfred */ 55892719Salfredint accept_filt_add(struct accept_filter *filt); 55992719Salfredint accept_filt_del(char *name); 56095959Salfredstruct accept_filter *accept_filt_get(char *name); 56161837Salfred#ifdef ACCEPT_FILTER_MOD 56295959Salfred#ifdef SYSCTL_DECL 56365534SalfredSYSCTL_DECL(_net_inet_accf); 56495959Salfred#endif 56595959Salfredint accept_filt_generic_mod_event(module_t mod, int event, void *data); 56695959Salfred#endif 56761837Salfred 56855205Speter#endif /* _KERNEL */ 5692165Spaul 57014505Shsu#endif /* !_SYS_SOCKETVAR_H_ */ 571