socketvar.h revision 180198
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 180198 2008-07-02 23:23:27Z 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 */ 113179027Sgnn u_int sb_mcnt; /* (c/d) number of mbufs in buffer */ 114179027Sgnn u_int sb_ccnt; /* (c/d) number of clusters in buffer */ 115130527Srwatson u_int sb_mbmax; /* (c/d) max chars of mbufs to use */ 116130527Srwatson u_int sb_ctl; /* (c/d) non-data chars in buffer */ 117130527Srwatson int sb_lowat; /* (c/d) low water mark */ 118130527Srwatson int sb_timeo; /* (c/d) timeout for read/write */ 119130527Srwatson short sb_flags; /* (c/d) flags, see below */ 1201541Srgrimes } so_rcv, so_snd; 121130818Srwatson/* 122130818Srwatson * Constants for sb_flags field of struct sockbuf. 123130818Srwatson */ 1241541Srgrimes#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 125131022Srwatson/* 126131022Srwatson * Constants for sb_flags field of struct sockbuf. 127131022Srwatson */ 1281541Srgrimes#define SB_WAIT 0x04 /* someone is waiting for data/space */ 1291541Srgrimes#define SB_SEL 0x08 /* someone is selecting */ 1301541Srgrimes#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 13136527Speter#define SB_UPCALL 0x20 /* someone wants an upcall */ 1321541Srgrimes#define SB_NOINTR 0x40 /* operations not interruptible */ 133167717Sandre#define SB_AIO 0x80 /* AIO operations queued */ 134167717Sandre#define SB_KNOTE 0x100 /* kernel note attached */ 135174711Skmacy#define SB_NOCOALESCE 0x200 /* don't coalesce new data into existing mbufs */ 136166404Sandre#define SB_AUTOSIZE 0x800 /* automatically size socket buffer */ 1371541Srgrimes 13897658Stanimura void (*so_upcall)(struct socket *, void *, int); 13997658Stanimura void *so_upcallarg; 140130527Srwatson struct ucred *so_cred; /* (a) user credentials */ 141130398Srwatson struct label *so_label; /* (b) MAC label for socket */ 142130398Srwatson struct label *so_peerlabel; /* (b) cached MAC label for peer */ 143160605Srwatson /* NB: generation count must not be first. */ 144131168Srwatson so_gen_t so_gencnt; /* (h) generation count */ 145147852Sjhb void *so_emuldata; /* (b) private data for emulators */ 14697658Stanimura struct so_accf { 14797658Stanimura struct accept_filter *so_accept_filter; 14897658Stanimura void *so_accept_filter_arg; /* saved filter args */ 14997658Stanimura char *so_accept_filter_str; /* saved user args */ 15097658Stanimura } *so_accf; 151178888Sjulian int so_fibnum; /* routing domain for this socket */ 1521541Srgrimes}; 1531541Srgrimes 154121628Ssam#define SB_EMPTY_FIXUP(sb) do { \ 155121628Ssam if ((sb)->sb_mb == NULL) { \ 156121628Ssam (sb)->sb_mbtail = NULL; \ 157121628Ssam (sb)->sb_lastrecord = NULL; \ 158121628Ssam } \ 159121628Ssam} while (/*CONSTCOND*/0) 160121628Ssam 1611541Srgrimes/* 162129979Srwatson * Global accept mutex to serialize access to accept queues and 163129979Srwatson * fields associated with multiple sockets. This allows us to 164129979Srwatson * avoid defining a lock order between listen and accept sockets 165129979Srwatson * until such time as it proves to be a good idea. 166129979Srwatson */ 167129979Srwatsonextern struct mtx accept_mtx; 168136682Srwatson#define ACCEPT_LOCK_ASSERT() mtx_assert(&accept_mtx, MA_OWNED) 169136682Srwatson#define ACCEPT_UNLOCK_ASSERT() mtx_assert(&accept_mtx, MA_NOTOWNED) 170130364Srwatson#define ACCEPT_LOCK() mtx_lock(&accept_mtx) 171130364Srwatson#define ACCEPT_UNLOCK() mtx_unlock(&accept_mtx) 172129979Srwatson 173129979Srwatson/* 174130380Srwatson * Per-socket buffer mutex used to protect most fields in the socket 175130380Srwatson * buffer. 176130380Srwatson */ 177130380Srwatson#define SOCKBUF_MTX(_sb) (&(_sb)->sb_mtx) 178130380Srwatson#define SOCKBUF_LOCK_INIT(_sb, _name) \ 179130380Srwatson mtx_init(SOCKBUF_MTX(_sb), _name, NULL, MTX_DEF) 180130380Srwatson#define SOCKBUF_LOCK_DESTROY(_sb) mtx_destroy(SOCKBUF_MTX(_sb)) 181130380Srwatson#define SOCKBUF_LOCK(_sb) mtx_lock(SOCKBUF_MTX(_sb)) 182130380Srwatson#define SOCKBUF_OWNED(_sb) mtx_owned(SOCKBUF_MTX(_sb)) 183130380Srwatson#define SOCKBUF_UNLOCK(_sb) mtx_unlock(SOCKBUF_MTX(_sb)) 184130380Srwatson#define SOCKBUF_LOCK_ASSERT(_sb) mtx_assert(SOCKBUF_MTX(_sb), MA_OWNED) 185136326Srwatson#define SOCKBUF_UNLOCK_ASSERT(_sb) mtx_assert(SOCKBUF_MTX(_sb), MA_NOTOWNED) 186130380Srwatson 187130380Srwatson/* 188130380Srwatson * Per-socket mutex: we reuse the receive socket buffer mutex for space 189130380Srwatson * efficiency. This decision should probably be revisited as we optimize 190130380Srwatson * locking for the socket code. 191130380Srwatson */ 192130380Srwatson#define SOCK_MTX(_so) SOCKBUF_MTX(&(_so)->so_rcv) 193130380Srwatson#define SOCK_LOCK(_so) SOCKBUF_LOCK(&(_so)->so_rcv) 194130380Srwatson#define SOCK_OWNED(_so) SOCKBUF_OWNED(&(_so)->so_rcv) 195130380Srwatson#define SOCK_UNLOCK(_so) SOCKBUF_UNLOCK(&(_so)->so_rcv) 196130380Srwatson#define SOCK_LOCK_ASSERT(_so) SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv) 197130380Srwatson 198130492Srwatson/* 1991541Srgrimes * Socket state bits. 200130480Srwatson * 201130480Srwatson * Historically, this bits were all kept in the so_state field. For 202130480Srwatson * locking reasons, they are now in multiple fields, as they are 203130480Srwatson * locked differently. so_state maintains basic socket state protected 204130480Srwatson * by the socket lock. so_qstate holds information about the socket 205130480Srwatson * accept queues. Each socket buffer also has a state field holding 206130480Srwatson * information relevant to that socket buffer (can't send, rcv). Many 207130480Srwatson * fields will be read without locks to improve performance and avoid 208130480Srwatson * lock order issues. However, this approach must be used with caution. 2091541Srgrimes */ 21014547Sdg#define SS_NOFDREF 0x0001 /* no file table ref any more */ 21114547Sdg#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 21214547Sdg#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 21314547Sdg#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 21414547Sdg#define SS_NBIO 0x0100 /* non-blocking ops */ 21514547Sdg#define SS_ASYNC 0x0200 /* async i/o notify */ 21614547Sdg#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 21743196Sfenner#define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */ 218157360Srwatson/* 219157360Srwatson * Protocols can mark a socket as SS_PROTOREF to indicate that, following 220157360Srwatson * pru_detach, they still want the socket to persist, and will free it 221157360Srwatson * themselves when they are done. Protocols should only ever call sofree() 222157360Srwatson * following setting this flag in pru_detach(), and never otherwise, as 223157360Srwatson * sofree() bypasses socket reference counting. 224157360Srwatson */ 225156746Srwatson#define SS_PROTOREF 0x4000 /* strong protocol reference */ 2261541Srgrimes 22736079Swollman/* 228130480Srwatson * Socket state bits now stored in the socket buffer state field. 229130480Srwatson */ 230130480Srwatson#define SBS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 231130480Srwatson#define SBS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 232130480Srwatson#define SBS_RCVATMARK 0x0040 /* at mark on input */ 233130480Srwatson 234130480Srwatson/* 235129916Srwatson * Socket state bits stored in so_qstate. 236129916Srwatson */ 237129916Srwatson#define SQ_INCOMP 0x0800 /* unaccepted, incomplete connection */ 238129916Srwatson#define SQ_COMP 0x1000 /* unaccepted, complete connection */ 239129916Srwatson 240129916Srwatson/* 24136079Swollman * Externalized form of struct socket used by the sysctl(3) interface. 24236079Swollman */ 24383045Sobrienstruct xsocket { 24436079Swollman size_t xso_len; /* length of this structure */ 24536079Swollman struct socket *xso_so; /* makes a convenient handle sometimes */ 24636079Swollman short so_type; 24736079Swollman short so_options; 24836079Swollman short so_linger; 24936079Swollman short so_state; 25036079Swollman caddr_t so_pcb; /* another convenient handle */ 25136079Swollman int xso_protocol; 25236079Swollman int xso_family; 253140730Sglebius u_short so_qlen; 254140730Sglebius u_short so_incqlen; 255140730Sglebius u_short so_qlimit; 25636079Swollman short so_timeo; 25736079Swollman u_short so_error; 25836079Swollman pid_t so_pgid; 25936079Swollman u_long so_oobmark; 26083421Sobrien struct xsockbuf { 261100591Sjdp u_int sb_cc; 262100591Sjdp u_int sb_hiwat; 263100591Sjdp u_int sb_mbcnt; 264179027Sgnn u_int sb_mcnt; 265179027Sgnn u_int sb_ccnt; 266100591Sjdp u_int sb_mbmax; 267100591Sjdp int sb_lowat; 268100591Sjdp int sb_timeo; 26936079Swollman short sb_flags; 27036079Swollman } so_rcv, so_snd; 27136079Swollman uid_t so_uid; /* XXX */ 27236079Swollman}; 27314547Sdg 274130393Srwatson#ifdef _KERNEL 275130393Srwatson 2761541Srgrimes/* 2771541Srgrimes * Macros for sockets and socket buffering. 2781541Srgrimes */ 2791541Srgrimes 2801541Srgrimes/* 281175845Srwatson * Flags to sblock(). 282175845Srwatson */ 283175845Srwatson#define SBL_WAIT 0x00000001 /* Wait if not immediately available. */ 284175845Srwatson#define SBL_NOINTR 0x00000002 /* Force non-interruptible sleep. */ 285175845Srwatson#define SBL_VALID (SBL_WAIT | SBL_NOINTR) 286175845Srwatson 287175845Srwatson/* 28836527Speter * Do we need to notify the other side when I/O is possible? 28936527Speter */ 29055943Sjasone#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \ 29159288Sjlemon SB_UPCALL | SB_AIO | SB_KNOTE)) != 0) 29236527Speter 29336527Speter/* 2941541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 2951541Srgrimes * This is problematical if the fields are unsigned, as the space might 2961541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 2971541Srgrimes * overflow and return 0. Should use "lmin" but it doesn't exist now. 2981541Srgrimes */ 2991541Srgrimes#define sbspace(sb) \ 3001541Srgrimes ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 3011541Srgrimes (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 3021541Srgrimes 3031541Srgrimes/* do we have to send all at once on a socket? */ 3041541Srgrimes#define sosendallatonce(so) \ 3051541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 3061541Srgrimes 3071541Srgrimes/* can we read something from so? */ 3081541Srgrimes#define soreadable(so) \ 3091541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 310130480Srwatson ((so)->so_rcv.sb_state & SBS_CANTRCVMORE) || \ 31170536Sphk !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error) 3121541Srgrimes 3131541Srgrimes/* can we write something to so? */ 3141541Srgrimes#define sowriteable(so) \ 3153304Sphk ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 3161541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 3173304Sphk ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 318130480Srwatson ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \ 3191541Srgrimes (so)->so_error) 3201541Srgrimes 3211541Srgrimes/* adjust counters in sb reflecting allocation of m */ 3221541Srgrimes#define sballoc(sb, m) { \ 3231541Srgrimes (sb)->sb_cc += (m)->m_len; \ 324151967Sandre if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \ 325106313Skbyanc (sb)->sb_ctl += (m)->m_len; \ 3261541Srgrimes (sb)->sb_mbcnt += MSIZE; \ 327179027Sgnn (sb)->sb_mcnt += 1; \ 328179027Sgnn if ((m)->m_flags & M_EXT) { \ 3291541Srgrimes (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 330179027Sgnn (sb)->sb_ccnt += 1; \ 331179027Sgnn } \ 3321541Srgrimes} 3331541Srgrimes 3341541Srgrimes/* adjust counters in sb reflecting freeing of m */ 3351541Srgrimes#define sbfree(sb, m) { \ 3361541Srgrimes (sb)->sb_cc -= (m)->m_len; \ 337151967Sandre if ((m)->m_type != MT_DATA && (m)->m_type != MT_OOBDATA) \ 338106313Skbyanc (sb)->sb_ctl -= (m)->m_len; \ 3391541Srgrimes (sb)->sb_mbcnt -= MSIZE; \ 340179027Sgnn (sb)->sb_mcnt -= 1; \ 341179027Sgnn if ((m)->m_flags & M_EXT) { \ 3421541Srgrimes (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 343179027Sgnn (sb)->sb_ccnt -= 1; \ 344179027Sgnn } \ 345167715Sandre if ((sb)->sb_sndptr == (m)) { \ 346167715Sandre (sb)->sb_sndptr = NULL; \ 347167715Sandre (sb)->sb_sndptroff = 0; \ 348167715Sandre } \ 349167715Sandre if ((sb)->sb_sndptroff != 0) \ 350167715Sandre (sb)->sb_sndptroff -= (m)->m_len; \ 3511541Srgrimes} 3521541Srgrimes 3531541Srgrimes/* 35486487Sdillon * soref()/sorele() ref-count the socket structure. Note that you must 35586487Sdillon * still explicitly close the socket, but the last ref count will free 35686487Sdillon * the structure. 35786487Sdillon */ 358130383Srwatson#define soref(so) do { \ 359130387Srwatson SOCK_LOCK_ASSERT(so); \ 360130383Srwatson ++(so)->so_count; \ 361130383Srwatson} while (0) 36286487Sdillon 363130383Srwatson#define sorele(so) do { \ 364136682Srwatson ACCEPT_LOCK_ASSERT(); \ 365130387Srwatson SOCK_LOCK_ASSERT(so); \ 366130383Srwatson if ((so)->so_count <= 0) \ 367130383Srwatson panic("sorele"); \ 368130383Srwatson if (--(so)->so_count == 0) \ 369130383Srwatson sofree(so); \ 370136682Srwatson else { \ 371130387Srwatson SOCK_UNLOCK(so); \ 372136682Srwatson ACCEPT_UNLOCK(); \ 373136682Srwatson } \ 374130383Srwatson} while (0) 37586487Sdillon 376130383Srwatson#define sotryfree(so) do { \ 377136682Srwatson ACCEPT_LOCK_ASSERT(); \ 378130387Srwatson SOCK_LOCK_ASSERT(so); \ 379130383Srwatson if ((so)->so_count == 0) \ 380130383Srwatson sofree(so); \ 381136682Srwatson else { \ 382130387Srwatson SOCK_UNLOCK(so); \ 383136682Srwatson ACCEPT_UNLOCK(); \ 384136682Srwatson } \ 385130383Srwatson} while(0) 38686487Sdillon 387130831Srwatson/* 388130831Srwatson * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to 389130831Srwatson * avoid a non-atomic test-and-wakeup. However, sowakeup is 390130831Srwatson * responsible for releasing the lock if it is called. We unlock only 391130831Srwatson * if we don't call into sowakeup. If any code is introduced that 392130831Srwatson * directly invokes the underlying sowakeup() primitives, it must 393130831Srwatson * maintain the same semantics. 394130831Srwatson */ 395130831Srwatson#define sorwakeup_locked(so) do { \ 396130831Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_rcv); \ 397130383Srwatson if (sb_notify(&(so)->so_rcv)) \ 398130831Srwatson sowakeup((so), &(so)->so_rcv); \ 399130831Srwatson else \ 400130831Srwatson SOCKBUF_UNLOCK(&(so)->so_rcv); \ 401130383Srwatson} while (0) 4021541Srgrimes 403130831Srwatson#define sorwakeup(so) do { \ 404130831Srwatson SOCKBUF_LOCK(&(so)->so_rcv); \ 405130831Srwatson sorwakeup_locked(so); \ 406130831Srwatson} while (0) 407130831Srwatson 408130831Srwatson#define sowwakeup_locked(so) do { \ 409131029Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_snd); \ 410130383Srwatson if (sb_notify(&(so)->so_snd)) \ 411130383Srwatson sowakeup((so), &(so)->so_snd); \ 412130831Srwatson else \ 413130831Srwatson SOCKBUF_UNLOCK(&(so)->so_snd); \ 414130383Srwatson} while (0) 4151541Srgrimes 416130831Srwatson#define sowwakeup(so) do { \ 417130831Srwatson SOCKBUF_LOCK(&(so)->so_snd); \ 418130831Srwatson sowwakeup_locked(so); \ 419130831Srwatson} while (0) 420130831Srwatson 42138482Swollman/* 42238482Swollman * Argument structure for sosetopt et seq. This is in the KERNEL 42338482Swollman * section because it will never be visible to user code. 42438482Swollman */ 42538482Swollmanenum sopt_dir { SOPT_GET, SOPT_SET }; 42638482Swollmanstruct sockopt { 42738482Swollman enum sopt_dir sopt_dir; /* is this a get or a set? */ 42838482Swollman int sopt_level; /* second arg of [gs]etsockopt */ 42938482Swollman int sopt_name; /* third arg of [gs]etsockopt */ 43038482Swollman void *sopt_val; /* fourth arg of [gs]etsockopt */ 43138482Swollman size_t sopt_valsize; /* (almost) fifth arg of [gs]etsockopt */ 43295959Salfred struct thread *sopt_td; /* calling thread or null if kernel */ 43338482Swollman}; 43438482Swollman 43561837Salfredstruct accept_filter { 43661837Salfred char accf_name[16]; 43761837Salfred void (*accf_callback) 43892719Salfred (struct socket *so, void *arg, int waitflag); 43961837Salfred void * (*accf_create) 44092719Salfred (struct socket *so, char *arg); 44161837Salfred void (*accf_destroy) 44292719Salfred (struct socket *so); 44395959Salfred SLIST_ENTRY(accept_filter) accf_next; 44482656Sjlemon}; 44561837Salfred 44631927Sbde#ifdef MALLOC_DECLARE 44795959SalfredMALLOC_DECLARE(M_ACCF); 44831927SbdeMALLOC_DECLARE(M_PCB); 44931927SbdeMALLOC_DECLARE(M_SONAME); 45031927Sbde#endif 45131927Sbde 45295959Salfredextern int maxsockets; 4532112Swollmanextern u_long sb_max; 45495959Salfredextern struct uma_zone *socket_zone; 45536079Swollmanextern so_gen_t so_gencnt; 45614505Shsu 45715492Sbdestruct mbuf; 45815492Sbdestruct sockaddr; 45932995Sbdestruct ucred; 46032995Sbdestruct uio; 46115492Sbde 4621541Srgrimes/* 4633304Sphk * From uipc_socket and friends 4643304Sphk */ 465143463Srwatsonint do_getopt_accept_filter(struct socket *so, struct sockopt *sopt); 466142058Srwatsonint do_setopt_accept_filter(struct socket *so, struct sockopt *sopt); 467132060Sdwmaloneint so_setsockopt(struct socket *so, int level, int optname, 468132060Sdwmalone void *optval, size_t optlen); 46992719Salfredint sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type); 47092719Salfredint getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len); 47192719Salfredvoid sbappend(struct sockbuf *sb, struct mbuf *m); 472130831Srwatsonvoid sbappend_locked(struct sockbuf *sb, struct mbuf *m); 473121628Ssamvoid sbappendstream(struct sockbuf *sb, struct mbuf *m); 474130831Srwatsonvoid sbappendstream_locked(struct sockbuf *sb, struct mbuf *m); 475130050Srwatsonint sbappendaddr(struct sockbuf *sb, const struct sockaddr *asa, 47692719Salfred struct mbuf *m0, struct mbuf *control); 477130831Srwatsonint sbappendaddr_locked(struct sockbuf *sb, const struct sockaddr *asa, 478130831Srwatson struct mbuf *m0, struct mbuf *control); 47992719Salfredint sbappendcontrol(struct sockbuf *sb, struct mbuf *m0, 48092719Salfred struct mbuf *control); 481130831Srwatsonint sbappendcontrol_locked(struct sockbuf *sb, struct mbuf *m0, 482130831Srwatson struct mbuf *control); 48392719Salfredvoid sbappendrecord(struct sockbuf *sb, struct mbuf *m0); 484130831Srwatsonvoid sbappendrecord_locked(struct sockbuf *sb, struct mbuf *m0); 48592719Salfredvoid sbcheck(struct sockbuf *sb); 48692719Salfredvoid sbcompress(struct sockbuf *sb, struct mbuf *m, struct mbuf *n); 48719670Sbdestruct mbuf * 48892719Salfred sbcreatecontrol(caddr_t p, int size, int type, int level); 489160875Srwatsonvoid sbdestroy(struct sockbuf *sb, struct socket *so); 49092719Salfredvoid sbdrop(struct sockbuf *sb, int len); 491130831Srwatsonvoid sbdrop_locked(struct sockbuf *sb, int len); 49292719Salfredvoid sbdroprecord(struct sockbuf *sb); 493130831Srwatsonvoid sbdroprecord_locked(struct sockbuf *sb); 49492719Salfredvoid sbflush(struct sockbuf *sb); 495130831Srwatsonvoid sbflush_locked(struct sockbuf *sb); 49692719Salfredvoid sbrelease(struct sockbuf *sb, struct socket *so); 497175968Srwatsonvoid sbrelease_internal(struct sockbuf *sb, struct socket *so); 498130831Srwatsonvoid sbrelease_locked(struct sockbuf *sb, struct socket *so); 49992719Salfredint sbreserve(struct sockbuf *sb, u_long cc, struct socket *so, 50093008Sbde struct thread *td); 501131006Srwatsonint sbreserve_locked(struct sockbuf *sb, u_long cc, struct socket *so, 502131006Srwatson struct thread *td); 503167715Sandrestruct mbuf * 504167715Sandre sbsndptr(struct sockbuf *sb, u_int off, u_int len, u_int *moff); 50592719Salfredvoid sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb); 50692719Salfredint sbwait(struct sockbuf *sb); 507169236Srwatsonint sblock(struct sockbuf *sb, int flags); 508169236Srwatsonvoid sbunlock(struct sockbuf *sb); 509156763Srwatsonvoid soabort(struct socket *so); 51092719Salfredint soaccept(struct socket *so, struct sockaddr **nam); 51195959Salfredint socheckuid(struct socket *so, uid_t uid); 51292719Salfredint sobind(struct socket *so, struct sockaddr *nam, struct thread *td); 51392719Salfredvoid socantrcvmore(struct socket *so); 514130831Srwatsonvoid socantrcvmore_locked(struct socket *so); 51592719Salfredvoid socantsendmore(struct socket *so); 516130831Srwatsonvoid socantsendmore_locked(struct socket *so); 51792719Salfredint soclose(struct socket *so); 51892719Salfredint soconnect(struct socket *so, struct sockaddr *nam, struct thread *td); 51992719Salfredint soconnect2(struct socket *so1, struct socket *so2); 52098849Skenint socow_setup(struct mbuf *m0, struct uio *uio); 52192719Salfredint socreate(int dom, struct socket **aso, int type, int proto, 52292719Salfred struct ucred *cred, struct thread *td); 52392719Salfredint sodisconnect(struct socket *so); 524126425Srwatsonstruct sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags); 52592719Salfredvoid sofree(struct socket *so); 52692719Salfredint sogetopt(struct socket *so, struct sockopt *sopt); 52792719Salfredvoid sohasoutofband(struct socket *so); 52892719Salfredvoid soisconnected(struct socket *so); 52992719Salfredvoid soisconnecting(struct socket *so); 53092719Salfredvoid soisdisconnected(struct socket *so); 53192719Salfredvoid soisdisconnecting(struct socket *so); 53292719Salfredint solisten(struct socket *so, int backlog, struct thread *td); 533151888Srwatsonvoid solisten_proto(struct socket *so, int backlog); 534142190Srwatsonint solisten_proto_check(struct socket *so); 53514505Shsustruct socket * 53692719Salfred sonewconn(struct socket *head, int connstatus); 53793008Sbdeint sooptcopyin(struct sockopt *sopt, void *buf, size_t len, size_t minlen); 538118453Shsuint sooptcopyout(struct sockopt *sopt, const void *buf, size_t len); 53953541Sshin 54053541Sshin/* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */ 54192719Salfredint soopt_getm(struct sockopt *sopt, struct mbuf **mp); 54292719Salfredint soopt_mcopyin(struct sockopt *sopt, struct mbuf *m); 54392719Salfredint soopt_mcopyout(struct sockopt *sopt, struct mbuf *m); 54453541Sshin 545101983Srwatsonint sopoll(struct socket *so, int events, struct ucred *active_cred, 54693008Sbde struct thread *td); 547160619Srwatsonint sopoll_generic(struct socket *so, int events, 548160619Srwatson struct ucred *active_cred, struct thread *td); 54993008Sbdeint soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio, 55093008Sbde struct mbuf **mp0, struct mbuf **controlp, int *flagsp); 551180198Srwatsonint soreceive_dgram(struct socket *so, struct sockaddr **paddr, 552180198Srwatson struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 553180198Srwatson int *flagsp); 554160619Srwatsonint soreceive_generic(struct socket *so, struct sockaddr **paddr, 555160619Srwatson struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 556160619Srwatson int *flagsp); 55792719Salfredint soreserve(struct socket *so, u_long sndcc, u_long rcvcc); 55892719Salfredvoid sorflush(struct socket *so); 55992719Salfredint sosend(struct socket *so, struct sockaddr *addr, struct uio *uio, 56093008Sbde struct mbuf *top, struct mbuf *control, int flags, 56193008Sbde struct thread *td); 562154294Srwatsonint sosend_dgram(struct socket *so, struct sockaddr *addr, 563154294Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 564154294Srwatson int flags, struct thread *td); 565160619Srwatsonint sosend_generic(struct socket *so, struct sockaddr *addr, 566160619Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 567160619Srwatson int flags, struct thread *td); 56892719Salfredint sosetopt(struct socket *so, struct sockopt *sopt); 56992719Salfredint soshutdown(struct socket *so, int how); 57092719Salfredvoid sotoxsocket(struct socket *so, struct xsocket *xso); 57192719Salfredvoid sowakeup(struct socket *so, struct sockbuf *sb); 572174647Sjeffint selsocket(struct socket *so, int events, struct timeval *tv, 573174647Sjeff struct thread *td); 57431927Sbde 575121628Ssam#ifdef SOCKBUF_DEBUG 576121628Ssamvoid sblastrecordchk(struct sockbuf *, const char *, int); 577121628Ssam#define SBLASTRECORDCHK(sb) sblastrecordchk((sb), __FILE__, __LINE__) 578121628Ssam 579121628Ssamvoid sblastmbufchk(struct sockbuf *, const char *, int); 580121628Ssam#define SBLASTMBUFCHK(sb) sblastmbufchk((sb), __FILE__, __LINE__) 581121628Ssam#else 582121628Ssam#define SBLASTRECORDCHK(sb) /* nothing */ 583121628Ssam#define SBLASTMBUFCHK(sb) /* nothing */ 584121628Ssam#endif /* SOCKBUF_DEBUG */ 585121628Ssam 58695959Salfred/* 58795959Salfred * Accept filter functions (duh). 58895959Salfred */ 58992719Salfredint accept_filt_add(struct accept_filter *filt); 59092719Salfredint accept_filt_del(char *name); 59195959Salfredstruct accept_filter *accept_filt_get(char *name); 59261837Salfred#ifdef ACCEPT_FILTER_MOD 59395959Salfred#ifdef SYSCTL_DECL 59465534SalfredSYSCTL_DECL(_net_inet_accf); 59595959Salfred#endif 59695959Salfredint accept_filt_generic_mod_event(module_t mod, int event, void *data); 59795959Salfred#endif 59861837Salfred 59955205Speter#endif /* _KERNEL */ 6002165Spaul 60114505Shsu#endif /* !_SYS_SOCKETVAR_H_ */ 602