socketvar.h revision 191688
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 30180948Skmacy * 3150477Speter * $FreeBSD: head/sys/sys/socketvar.h 191688 2009-04-30 13:36:26Z zec $ 321541Srgrimes */ 331541Srgrimes 342165Spaul#ifndef _SYS_SOCKETVAR_H_ 352165Spaul#define _SYS_SOCKETVAR_H_ 362165Spaul 3715492Sbde#include <sys/queue.h> /* for TAILQ macros */ 3870834Swollman#include <sys/selinfo.h> /* for struct selinfo */ 39130380Srwatson#include <sys/_lock.h> 40130380Srwatson#include <sys/_mutex.h> 41169236Srwatson#include <sys/_sx.h> 42180948Skmacy#include <sys/sockbuf.h> 43180948Skmacy#include <sys/sockstate.h> 44180948Skmacy#ifdef _KERNEL 45180948Skmacy#include <sys/sockopt.h> 46180948Skmacy#endif 471541Srgrimes 48191688Szecstruct vnet; 49191688Szec 501541Srgrimes/* 511541Srgrimes * Kernel structure per socket. 521541Srgrimes * Contains send and receive buffer queues, 531541Srgrimes * handle on protocol and pointer to protocol 541541Srgrimes * private data and error information. 551541Srgrimes */ 5636079Swollmantypedef u_quad_t so_gen_t; 5736079Swollman 58129958Srwatson/*- 59129958Srwatson * Locking key to struct socket: 60129958Srwatson * (a) constant after allocation, no locking required. 61129958Srwatson * (b) locked by SOCK_LOCK(so). 62129958Srwatson * (c) locked by SOCKBUF_LOCK(&so->so_rcv). 63129958Srwatson * (d) locked by SOCKBUF_LOCK(&so->so_snd). 64129958Srwatson * (e) locked by ACCEPT_LOCK(). 65129958Srwatson * (f) not locked since integer reads/writes are atomic. 66129958Srwatson * (g) used only as a sleep/wakeup address, no value. 67131168Srwatson * (h) locked by global mutex so_global_mtx. 6895552Stanimura */ 691541Srgrimesstruct socket { 70130387Srwatson int so_count; /* (b) reference count */ 71129958Srwatson short so_type; /* (a) generic type, see socket.h */ 7297658Stanimura short so_options; /* from socket call, see socket.h */ 7397658Stanimura short so_linger; /* time to linger while closing */ 74130818Srwatson short so_state; /* (b) internal state flags SS_* */ 75129979Srwatson int so_qstate; /* (e) internal state flags SQ_* */ 7698993Salfred void *so_pcb; /* protocol control block */ 77191688Szec struct vnet *so_vnet; /* network stack instance */ 78129958Srwatson struct protosw *so_proto; /* (a) protocol handle */ 791541Srgrimes/* 8013765Smpp * Variables for connection queuing. 811541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets. 821541Srgrimes * If so_head is 0, socket is not related to an accept. 8378913Sjlemon * For head socket so_incomp queues partially completed connections, 8478913Sjlemon * while so_comp is a queue of connections ready to be accepted. 851541Srgrimes * If a connection is aborted and it has so_head set, then 8678913Sjlemon * it has to be pulled out of either so_incomp or so_comp. 871541Srgrimes * We allow connections to queue up based on current queue lengths 881541Srgrimes * and limit on number of queued connections for this socket. 891541Srgrimes */ 90160604Srwatson struct socket *so_head; /* (e) back pointer to listen socket */ 91129979Srwatson TAILQ_HEAD(, socket) so_incomp; /* (e) queue of partial unaccepted connections */ 92129979Srwatson TAILQ_HEAD(, socket) so_comp; /* (e) queue of complete unaccepted connections */ 93129979Srwatson TAILQ_ENTRY(socket) so_list; /* (e) list of unaccepted connections */ 94140730Sglebius u_short so_qlen; /* (e) number of unaccepted connections */ 95140730Sglebius u_short so_incqlen; /* (e) number of unaccepted incomplete 9618787Spst connections */ 97140730Sglebius u_short so_qlimit; /* (e) max number queued connections */ 98130527Srwatson short so_timeo; /* (g) connection timeout */ 99131029Srwatson u_short so_error; /* (f) error affecting connection */ 10097658Stanimura struct sigio *so_sigio; /* [sg] information for async I/O or 10141087Struckman out of band data (SIGURG) */ 102131017Srwatson u_long so_oobmark; /* (c) chars to oob mark */ 10397658Stanimura TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ 1041541Srgrimes 105180948Skmacy struct sockbuf so_rcv, so_snd; 106180948Skmacy 10797658Stanimura void (*so_upcall)(struct socket *, void *, int); 10897658Stanimura void *so_upcallarg; 109130527Srwatson struct ucred *so_cred; /* (a) user credentials */ 110130398Srwatson struct label *so_label; /* (b) MAC label for socket */ 111130398Srwatson struct label *so_peerlabel; /* (b) cached MAC label for peer */ 112160605Srwatson /* NB: generation count must not be first. */ 113131168Srwatson so_gen_t so_gencnt; /* (h) generation count */ 114147852Sjhb void *so_emuldata; /* (b) private data for emulators */ 11597658Stanimura struct so_accf { 11697658Stanimura struct accept_filter *so_accept_filter; 11797658Stanimura void *so_accept_filter_arg; /* saved filter args */ 11897658Stanimura char *so_accept_filter_str; /* saved user args */ 11997658Stanimura } *so_accf; 120178888Sjulian int so_fibnum; /* routing domain for this socket */ 1211541Srgrimes}; 1221541Srgrimes 1231541Srgrimes/* 124129979Srwatson * Global accept mutex to serialize access to accept queues and 125129979Srwatson * fields associated with multiple sockets. This allows us to 126129979Srwatson * avoid defining a lock order between listen and accept sockets 127129979Srwatson * until such time as it proves to be a good idea. 128129979Srwatson */ 129129979Srwatsonextern struct mtx accept_mtx; 130136682Srwatson#define ACCEPT_LOCK_ASSERT() mtx_assert(&accept_mtx, MA_OWNED) 131136682Srwatson#define ACCEPT_UNLOCK_ASSERT() mtx_assert(&accept_mtx, MA_NOTOWNED) 132130364Srwatson#define ACCEPT_LOCK() mtx_lock(&accept_mtx) 133130364Srwatson#define ACCEPT_UNLOCK() mtx_unlock(&accept_mtx) 134129979Srwatson 135129979Srwatson/* 136130380Srwatson * Per-socket mutex: we reuse the receive socket buffer mutex for space 137130380Srwatson * efficiency. This decision should probably be revisited as we optimize 138130380Srwatson * locking for the socket code. 139130380Srwatson */ 140130380Srwatson#define SOCK_MTX(_so) SOCKBUF_MTX(&(_so)->so_rcv) 141130380Srwatson#define SOCK_LOCK(_so) SOCKBUF_LOCK(&(_so)->so_rcv) 142130380Srwatson#define SOCK_OWNED(_so) SOCKBUF_OWNED(&(_so)->so_rcv) 143130380Srwatson#define SOCK_UNLOCK(_so) SOCKBUF_UNLOCK(&(_so)->so_rcv) 144130380Srwatson#define SOCK_LOCK_ASSERT(_so) SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv) 145130380Srwatson 146130492Srwatson/* 147129916Srwatson * Socket state bits stored in so_qstate. 148129916Srwatson */ 149129916Srwatson#define SQ_INCOMP 0x0800 /* unaccepted, incomplete connection */ 150129916Srwatson#define SQ_COMP 0x1000 /* unaccepted, complete connection */ 151129916Srwatson 152129916Srwatson/* 15336079Swollman * Externalized form of struct socket used by the sysctl(3) interface. 15436079Swollman */ 15583045Sobrienstruct xsocket { 15636079Swollman size_t xso_len; /* length of this structure */ 15736079Swollman struct socket *xso_so; /* makes a convenient handle sometimes */ 15836079Swollman short so_type; 15936079Swollman short so_options; 16036079Swollman short so_linger; 16136079Swollman short so_state; 16236079Swollman caddr_t so_pcb; /* another convenient handle */ 16336079Swollman int xso_protocol; 16436079Swollman int xso_family; 165140730Sglebius u_short so_qlen; 166140730Sglebius u_short so_incqlen; 167140730Sglebius u_short so_qlimit; 16836079Swollman short so_timeo; 16936079Swollman u_short so_error; 17036079Swollman pid_t so_pgid; 17136079Swollman u_long so_oobmark; 172180948Skmacy struct xsockbuf so_rcv, so_snd; 17336079Swollman uid_t so_uid; /* XXX */ 17436079Swollman}; 17514547Sdg 176130393Srwatson#ifdef _KERNEL 177130393Srwatson 1781541Srgrimes/* 1791541Srgrimes * Macros for sockets and socket buffering. 1801541Srgrimes */ 1811541Srgrimes 1821541Srgrimes/* 183175845Srwatson * Flags to sblock(). 184175845Srwatson */ 185175845Srwatson#define SBL_WAIT 0x00000001 /* Wait if not immediately available. */ 186175845Srwatson#define SBL_NOINTR 0x00000002 /* Force non-interruptible sleep. */ 187175845Srwatson#define SBL_VALID (SBL_WAIT | SBL_NOINTR) 188175845Srwatson 189175845Srwatson/* 19036527Speter * Do we need to notify the other side when I/O is possible? 19136527Speter */ 19255943Sjasone#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \ 19359288Sjlemon SB_UPCALL | SB_AIO | SB_KNOTE)) != 0) 19436527Speter 1951541Srgrimes/* do we have to send all at once on a socket? */ 1961541Srgrimes#define sosendallatonce(so) \ 1971541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 1981541Srgrimes 1991541Srgrimes/* can we read something from so? */ 2001541Srgrimes#define soreadable(so) \ 2011541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 202130480Srwatson ((so)->so_rcv.sb_state & SBS_CANTRCVMORE) || \ 20370536Sphk !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error) 2041541Srgrimes 2051541Srgrimes/* can we write something to so? */ 2061541Srgrimes#define sowriteable(so) \ 2073304Sphk ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 2081541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 2093304Sphk ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 210130480Srwatson ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \ 2111541Srgrimes (so)->so_error) 2121541Srgrimes 2131541Srgrimes/* 21486487Sdillon * soref()/sorele() ref-count the socket structure. Note that you must 21586487Sdillon * still explicitly close the socket, but the last ref count will free 21686487Sdillon * the structure. 21786487Sdillon */ 218130383Srwatson#define soref(so) do { \ 219130387Srwatson SOCK_LOCK_ASSERT(so); \ 220130383Srwatson ++(so)->so_count; \ 221130383Srwatson} while (0) 22286487Sdillon 223130383Srwatson#define sorele(so) do { \ 224136682Srwatson ACCEPT_LOCK_ASSERT(); \ 225130387Srwatson SOCK_LOCK_ASSERT(so); \ 226130383Srwatson if ((so)->so_count <= 0) \ 227130383Srwatson panic("sorele"); \ 228130383Srwatson if (--(so)->so_count == 0) \ 229130383Srwatson sofree(so); \ 230136682Srwatson else { \ 231130387Srwatson SOCK_UNLOCK(so); \ 232136682Srwatson ACCEPT_UNLOCK(); \ 233136682Srwatson } \ 234130383Srwatson} while (0) 23586487Sdillon 236130383Srwatson#define sotryfree(so) do { \ 237136682Srwatson ACCEPT_LOCK_ASSERT(); \ 238130387Srwatson SOCK_LOCK_ASSERT(so); \ 239130383Srwatson if ((so)->so_count == 0) \ 240130383Srwatson sofree(so); \ 241136682Srwatson else { \ 242130387Srwatson SOCK_UNLOCK(so); \ 243136682Srwatson ACCEPT_UNLOCK(); \ 244136682Srwatson } \ 245130383Srwatson} while(0) 24686487Sdillon 247130831Srwatson/* 248130831Srwatson * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to 249130831Srwatson * avoid a non-atomic test-and-wakeup. However, sowakeup is 250130831Srwatson * responsible for releasing the lock if it is called. We unlock only 251130831Srwatson * if we don't call into sowakeup. If any code is introduced that 252130831Srwatson * directly invokes the underlying sowakeup() primitives, it must 253130831Srwatson * maintain the same semantics. 254130831Srwatson */ 255130831Srwatson#define sorwakeup_locked(so) do { \ 256130831Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_rcv); \ 257130383Srwatson if (sb_notify(&(so)->so_rcv)) \ 258130831Srwatson sowakeup((so), &(so)->so_rcv); \ 259130831Srwatson else \ 260130831Srwatson SOCKBUF_UNLOCK(&(so)->so_rcv); \ 261130383Srwatson} while (0) 2621541Srgrimes 263130831Srwatson#define sorwakeup(so) do { \ 264130831Srwatson SOCKBUF_LOCK(&(so)->so_rcv); \ 265130831Srwatson sorwakeup_locked(so); \ 266130831Srwatson} while (0) 267130831Srwatson 268130831Srwatson#define sowwakeup_locked(so) do { \ 269131029Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_snd); \ 270130383Srwatson if (sb_notify(&(so)->so_snd)) \ 271130383Srwatson sowakeup((so), &(so)->so_snd); \ 272130831Srwatson else \ 273130831Srwatson SOCKBUF_UNLOCK(&(so)->so_snd); \ 274130383Srwatson} while (0) 2751541Srgrimes 276130831Srwatson#define sowwakeup(so) do { \ 277130831Srwatson SOCKBUF_LOCK(&(so)->so_snd); \ 278130831Srwatson sowwakeup_locked(so); \ 279130831Srwatson} while (0) 280130831Srwatson 28161837Salfredstruct accept_filter { 28261837Salfred char accf_name[16]; 28361837Salfred void (*accf_callback) 28492719Salfred (struct socket *so, void *arg, int waitflag); 28561837Salfred void * (*accf_create) 28692719Salfred (struct socket *so, char *arg); 28761837Salfred void (*accf_destroy) 28892719Salfred (struct socket *so); 28995959Salfred SLIST_ENTRY(accept_filter) accf_next; 29082656Sjlemon}; 29161837Salfred 29231927Sbde#ifdef MALLOC_DECLARE 29395959SalfredMALLOC_DECLARE(M_ACCF); 29431927SbdeMALLOC_DECLARE(M_PCB); 29531927SbdeMALLOC_DECLARE(M_SONAME); 29631927Sbde#endif 29731927Sbde 29895959Salfredextern int maxsockets; 2992112Swollmanextern u_long sb_max; 30095959Salfredextern struct uma_zone *socket_zone; 30136079Swollmanextern so_gen_t so_gencnt; 30214505Shsu 30315492Sbdestruct mbuf; 30415492Sbdestruct sockaddr; 30532995Sbdestruct ucred; 30632995Sbdestruct uio; 30715492Sbde 3081541Srgrimes/* 3093304Sphk * From uipc_socket and friends 3103304Sphk */ 31192719Salfredint sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type); 31292719Salfredint getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len); 313156763Srwatsonvoid soabort(struct socket *so); 31492719Salfredint soaccept(struct socket *so, struct sockaddr **nam); 31595959Salfredint socheckuid(struct socket *so, uid_t uid); 31692719Salfredint sobind(struct socket *so, struct sockaddr *nam, struct thread *td); 31792719Salfredint soclose(struct socket *so); 31892719Salfredint soconnect(struct socket *so, struct sockaddr *nam, struct thread *td); 31992719Salfredint soconnect2(struct socket *so1, struct socket *so2); 32098849Skenint socow_setup(struct mbuf *m0, struct uio *uio); 32192719Salfredint socreate(int dom, struct socket **aso, int type, int proto, 32292719Salfred struct ucred *cred, struct thread *td); 32392719Salfredint sodisconnect(struct socket *so); 324126425Srwatsonstruct sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags); 32592719Salfredvoid sofree(struct socket *so); 32692719Salfredvoid sohasoutofband(struct socket *so); 32792719Salfredint solisten(struct socket *so, int backlog, struct thread *td); 328151888Srwatsonvoid solisten_proto(struct socket *so, int backlog); 329142190Srwatsonint solisten_proto_check(struct socket *so); 33014505Shsustruct socket * 33192719Salfred sonewconn(struct socket *head, int connstatus); 33253541Sshin 33353541Sshin 334101983Srwatsonint sopoll(struct socket *so, int events, struct ucred *active_cred, 33593008Sbde struct thread *td); 336160619Srwatsonint sopoll_generic(struct socket *so, int events, 337160619Srwatson struct ucred *active_cred, struct thread *td); 33893008Sbdeint soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio, 33993008Sbde struct mbuf **mp0, struct mbuf **controlp, int *flagsp); 340180198Srwatsonint soreceive_dgram(struct socket *so, struct sockaddr **paddr, 341180198Srwatson struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 342180198Srwatson int *flagsp); 343160619Srwatsonint soreceive_generic(struct socket *so, struct sockaddr **paddr, 344160619Srwatson struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 345160619Srwatson int *flagsp); 34692719Salfredint soreserve(struct socket *so, u_long sndcc, u_long rcvcc); 34792719Salfredvoid sorflush(struct socket *so); 34892719Salfredint sosend(struct socket *so, struct sockaddr *addr, struct uio *uio, 34993008Sbde struct mbuf *top, struct mbuf *control, int flags, 35093008Sbde struct thread *td); 351154294Srwatsonint sosend_dgram(struct socket *so, struct sockaddr *addr, 352154294Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 353154294Srwatson int flags, struct thread *td); 354160619Srwatsonint sosend_generic(struct socket *so, struct sockaddr *addr, 355160619Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 356160619Srwatson int flags, struct thread *td); 35792719Salfredint soshutdown(struct socket *so, int how); 35892719Salfredvoid sotoxsocket(struct socket *so, struct xsocket *xso); 35992719Salfredvoid sowakeup(struct socket *so, struct sockbuf *sb); 360174647Sjeffint selsocket(struct socket *so, int events, struct timeval *tv, 361174647Sjeff struct thread *td); 36231927Sbde 36395959Salfred/* 36495959Salfred * Accept filter functions (duh). 36595959Salfred */ 36692719Salfredint accept_filt_add(struct accept_filter *filt); 36792719Salfredint accept_filt_del(char *name); 36895959Salfredstruct accept_filter *accept_filt_get(char *name); 36961837Salfred#ifdef ACCEPT_FILTER_MOD 37095959Salfred#ifdef SYSCTL_DECL 37165534SalfredSYSCTL_DECL(_net_inet_accf); 37295959Salfred#endif 37395959Salfredint accept_filt_generic_mod_event(module_t mod, int event, void *data); 37495959Salfred#endif 37561837Salfred 37655205Speter#endif /* _KERNEL */ 3772165Spaul 37814505Shsu#endif /* !_SYS_SOCKETVAR_H_ */ 379