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$ 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 58193272Sjhbstruct socket; 59193272Sjhb 60210226Strasz/*- 61129958Srwatson * Locking key to struct socket: 62129958Srwatson * (a) constant after allocation, no locking required. 63129958Srwatson * (b) locked by SOCK_LOCK(so). 64129958Srwatson * (c) locked by SOCKBUF_LOCK(&so->so_rcv). 65129958Srwatson * (d) locked by SOCKBUF_LOCK(&so->so_snd). 66129958Srwatson * (e) locked by ACCEPT_LOCK(). 67129958Srwatson * (f) not locked since integer reads/writes are atomic. 68129958Srwatson * (g) used only as a sleep/wakeup address, no value. 69131168Srwatson * (h) locked by global mutex so_global_mtx. 7095552Stanimura */ 711541Srgrimesstruct socket { 72130387Srwatson int so_count; /* (b) reference count */ 73129958Srwatson short so_type; /* (a) generic type, see socket.h */ 7497658Stanimura short so_options; /* from socket call, see socket.h */ 7597658Stanimura short so_linger; /* time to linger while closing */ 76130818Srwatson short so_state; /* (b) internal state flags SS_* */ 77129979Srwatson int so_qstate; /* (e) internal state flags SQ_* */ 7898993Salfred void *so_pcb; /* protocol control block */ 79191688Szec struct vnet *so_vnet; /* network stack instance */ 80129958Srwatson struct protosw *so_proto; /* (a) protocol handle */ 811541Srgrimes/* 8213765Smpp * Variables for connection queuing. 831541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets. 841541Srgrimes * If so_head is 0, socket is not related to an accept. 8578913Sjlemon * For head socket so_incomp queues partially completed connections, 8678913Sjlemon * while so_comp is a queue of connections ready to be accepted. 871541Srgrimes * If a connection is aborted and it has so_head set, then 8878913Sjlemon * it has to be pulled out of either so_incomp or so_comp. 891541Srgrimes * We allow connections to queue up based on current queue lengths 901541Srgrimes * and limit on number of queued connections for this socket. 911541Srgrimes */ 92160604Srwatson struct socket *so_head; /* (e) back pointer to listen socket */ 93129979Srwatson TAILQ_HEAD(, socket) so_incomp; /* (e) queue of partial unaccepted connections */ 94129979Srwatson TAILQ_HEAD(, socket) so_comp; /* (e) queue of complete unaccepted connections */ 95129979Srwatson TAILQ_ENTRY(socket) so_list; /* (e) list of unaccepted connections */ 96140730Sglebius u_short so_qlen; /* (e) number of unaccepted connections */ 97140730Sglebius u_short so_incqlen; /* (e) number of unaccepted incomplete 9818787Spst connections */ 99140730Sglebius u_short so_qlimit; /* (e) max number queued connections */ 100130527Srwatson short so_timeo; /* (g) connection timeout */ 101131029Srwatson u_short so_error; /* (f) error affecting connection */ 10297658Stanimura struct sigio *so_sigio; /* [sg] information for async I/O or 10341087Struckman out of band data (SIGURG) */ 104131017Srwatson u_long so_oobmark; /* (c) chars to oob mark */ 10597658Stanimura TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ 1061541Srgrimes 107180948Skmacy struct sockbuf so_rcv, so_snd; 108180948Skmacy 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; 120215178Sluigi /* 121215178Sluigi * so_fibnum, so_user_cookie and friends can be used to attach 122215178Sluigi * some user-specified metadata to a socket, which then can be 123215178Sluigi * used by the kernel for various actions. 124215178Sluigi * so_user_cookie is used by ipfw/dummynet. 125215178Sluigi */ 126178888Sjulian int so_fibnum; /* routing domain for this socket */ 127215178Sluigi uint32_t so_user_cookie; 1281541Srgrimes}; 1291541Srgrimes 1301541Srgrimes/* 131129979Srwatson * Global accept mutex to serialize access to accept queues and 132129979Srwatson * fields associated with multiple sockets. This allows us to 133129979Srwatson * avoid defining a lock order between listen and accept sockets 134129979Srwatson * until such time as it proves to be a good idea. 135129979Srwatson */ 136250300Sandreextern struct mtx accept_mtx; 137136682Srwatson#define ACCEPT_LOCK_ASSERT() mtx_assert(&accept_mtx, MA_OWNED) 138136682Srwatson#define ACCEPT_UNLOCK_ASSERT() mtx_assert(&accept_mtx, MA_NOTOWNED) 139130364Srwatson#define ACCEPT_LOCK() mtx_lock(&accept_mtx) 140130364Srwatson#define ACCEPT_UNLOCK() mtx_unlock(&accept_mtx) 141129979Srwatson 142129979Srwatson/* 143130380Srwatson * Per-socket mutex: we reuse the receive socket buffer mutex for space 144130380Srwatson * efficiency. This decision should probably be revisited as we optimize 145130380Srwatson * locking for the socket code. 146130380Srwatson */ 147130380Srwatson#define SOCK_MTX(_so) SOCKBUF_MTX(&(_so)->so_rcv) 148130380Srwatson#define SOCK_LOCK(_so) SOCKBUF_LOCK(&(_so)->so_rcv) 149130380Srwatson#define SOCK_OWNED(_so) SOCKBUF_OWNED(&(_so)->so_rcv) 150130380Srwatson#define SOCK_UNLOCK(_so) SOCKBUF_UNLOCK(&(_so)->so_rcv) 151130380Srwatson#define SOCK_LOCK_ASSERT(_so) SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv) 152130380Srwatson 153130492Srwatson/* 154129916Srwatson * Socket state bits stored in so_qstate. 155129916Srwatson */ 156129916Srwatson#define SQ_INCOMP 0x0800 /* unaccepted, incomplete connection */ 157129916Srwatson#define SQ_COMP 0x1000 /* unaccepted, complete connection */ 158129916Srwatson 159129916Srwatson/* 16036079Swollman * Externalized form of struct socket used by the sysctl(3) interface. 16136079Swollman */ 16283045Sobrienstruct xsocket { 16336079Swollman size_t xso_len; /* length of this structure */ 16436079Swollman struct socket *xso_so; /* makes a convenient handle sometimes */ 16536079Swollman short so_type; 16636079Swollman short so_options; 16736079Swollman short so_linger; 16836079Swollman short so_state; 16936079Swollman caddr_t so_pcb; /* another convenient handle */ 17036079Swollman int xso_protocol; 17136079Swollman int xso_family; 172140730Sglebius u_short so_qlen; 173140730Sglebius u_short so_incqlen; 174140730Sglebius u_short so_qlimit; 17536079Swollman short so_timeo; 17636079Swollman u_short so_error; 17736079Swollman pid_t so_pgid; 17836079Swollman u_long so_oobmark; 179180948Skmacy struct xsockbuf so_rcv, so_snd; 18036079Swollman uid_t so_uid; /* XXX */ 18136079Swollman}; 18214547Sdg 183130393Srwatson#ifdef _KERNEL 184130393Srwatson 1851541Srgrimes/* 1861541Srgrimes * Macros for sockets and socket buffering. 1871541Srgrimes */ 1881541Srgrimes 1891541Srgrimes/* 190175845Srwatson * Flags to sblock(). 191175845Srwatson */ 192175845Srwatson#define SBL_WAIT 0x00000001 /* Wait if not immediately available. */ 193175845Srwatson#define SBL_NOINTR 0x00000002 /* Force non-interruptible sleep. */ 194175845Srwatson#define SBL_VALID (SBL_WAIT | SBL_NOINTR) 195175845Srwatson 196175845Srwatson/* 19736527Speter * Do we need to notify the other side when I/O is possible? 19836527Speter */ 19955943Sjasone#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \ 20059288Sjlemon SB_UPCALL | SB_AIO | SB_KNOTE)) != 0) 20136527Speter 2021541Srgrimes/* do we have to send all at once on a socket? */ 2031541Srgrimes#define sosendallatonce(so) \ 2041541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 2051541Srgrimes 2061541Srgrimes/* can we read something from so? */ 207195423Skib#define soreadabledata(so) \ 2081541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 20970536Sphk !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error) 210195423Skib#define soreadable(so) \ 211195423Skib (soreadabledata(so) || ((so)->so_rcv.sb_state & SBS_CANTRCVMORE)) 2121541Srgrimes 2131541Srgrimes/* can we write something to so? */ 2141541Srgrimes#define sowriteable(so) \ 2153304Sphk ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 2161541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 2173304Sphk ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 218130480Srwatson ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \ 2191541Srgrimes (so)->so_error) 2201541Srgrimes 2211541Srgrimes/* 22286487Sdillon * soref()/sorele() ref-count the socket structure. Note that you must 22386487Sdillon * still explicitly close the socket, but the last ref count will free 22486487Sdillon * the structure. 22586487Sdillon */ 226130383Srwatson#define soref(so) do { \ 227130387Srwatson SOCK_LOCK_ASSERT(so); \ 228130383Srwatson ++(so)->so_count; \ 229130383Srwatson} while (0) 23086487Sdillon 231130383Srwatson#define sorele(so) do { \ 232136682Srwatson ACCEPT_LOCK_ASSERT(); \ 233130387Srwatson SOCK_LOCK_ASSERT(so); \ 234130383Srwatson if ((so)->so_count <= 0) \ 235130383Srwatson panic("sorele"); \ 236130383Srwatson if (--(so)->so_count == 0) \ 237130383Srwatson sofree(so); \ 238136682Srwatson else { \ 239130387Srwatson SOCK_UNLOCK(so); \ 240136682Srwatson ACCEPT_UNLOCK(); \ 241136682Srwatson } \ 242130383Srwatson} while (0) 24386487Sdillon 244130831Srwatson/* 245130831Srwatson * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to 246130831Srwatson * avoid a non-atomic test-and-wakeup. However, sowakeup is 247130831Srwatson * responsible for releasing the lock if it is called. We unlock only 248130831Srwatson * if we don't call into sowakeup. If any code is introduced that 249130831Srwatson * directly invokes the underlying sowakeup() primitives, it must 250130831Srwatson * maintain the same semantics. 251130831Srwatson */ 252130831Srwatson#define sorwakeup_locked(so) do { \ 253130831Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_rcv); \ 254130383Srwatson if (sb_notify(&(so)->so_rcv)) \ 255130831Srwatson sowakeup((so), &(so)->so_rcv); \ 256130831Srwatson else \ 257130831Srwatson SOCKBUF_UNLOCK(&(so)->so_rcv); \ 258130383Srwatson} while (0) 2591541Srgrimes 260130831Srwatson#define sorwakeup(so) do { \ 261130831Srwatson SOCKBUF_LOCK(&(so)->so_rcv); \ 262130831Srwatson sorwakeup_locked(so); \ 263130831Srwatson} while (0) 264130831Srwatson 265130831Srwatson#define sowwakeup_locked(so) do { \ 266131029Srwatson SOCKBUF_LOCK_ASSERT(&(so)->so_snd); \ 267130383Srwatson if (sb_notify(&(so)->so_snd)) \ 268130383Srwatson sowakeup((so), &(so)->so_snd); \ 269130831Srwatson else \ 270130831Srwatson SOCKBUF_UNLOCK(&(so)->so_snd); \ 271130383Srwatson} while (0) 2721541Srgrimes 273130831Srwatson#define sowwakeup(so) do { \ 274130831Srwatson SOCKBUF_LOCK(&(so)->so_snd); \ 275130831Srwatson sowwakeup_locked(so); \ 276130831Srwatson} while (0) 277130831Srwatson 27861837Salfredstruct accept_filter { 27961837Salfred char accf_name[16]; 280193272Sjhb int (*accf_callback) 28192719Salfred (struct socket *so, void *arg, int waitflag); 28261837Salfred void * (*accf_create) 28392719Salfred (struct socket *so, char *arg); 28461837Salfred void (*accf_destroy) 28592719Salfred (struct socket *so); 28695959Salfred SLIST_ENTRY(accept_filter) accf_next; 28782656Sjlemon}; 28861837Salfred 28931927Sbde#ifdef MALLOC_DECLARE 29095959SalfredMALLOC_DECLARE(M_ACCF); 29131927SbdeMALLOC_DECLARE(M_PCB); 29231927SbdeMALLOC_DECLARE(M_SONAME); 29331927Sbde#endif 29431927Sbde 29595959Salfredextern int maxsockets; 2962112Swollmanextern u_long sb_max; 29736079Swollmanextern so_gen_t so_gencnt; 29814505Shsu 29915492Sbdestruct mbuf; 30015492Sbdestruct sockaddr; 30132995Sbdestruct ucred; 30232995Sbdestruct uio; 30315492Sbde 304193272Sjhb/* 'which' values for socket upcalls. */ 305193272Sjhb#define SO_RCV 1 306193272Sjhb#define SO_SND 2 307193272Sjhb 308193272Sjhb/* Return values for socket upcalls. */ 309193272Sjhb#define SU_OK 0 310193272Sjhb#define SU_ISCONNECTED 1 311193272Sjhb 3121541Srgrimes/* 3133304Sphk * From uipc_socket and friends 3143304Sphk */ 31592719Salfredint sockargs(struct mbuf **mp, caddr_t buf, int buflen, int type); 31692719Salfredint getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len); 317156763Srwatsonvoid soabort(struct socket *so); 31892719Salfredint soaccept(struct socket *so, struct sockaddr **nam); 31995959Salfredint socheckuid(struct socket *so, uid_t uid); 32092719Salfredint sobind(struct socket *so, struct sockaddr *nam, struct thread *td); 321247667Spjdint sobindat(int fd, struct socket *so, struct sockaddr *nam, 322247667Spjd struct thread *td); 32392719Salfredint soclose(struct socket *so); 32492719Salfredint soconnect(struct socket *so, struct sockaddr *nam, struct thread *td); 325247667Spjdint soconnectat(int fd, struct socket *so, struct sockaddr *nam, 326247667Spjd struct thread *td); 32792719Salfredint soconnect2(struct socket *so1, struct socket *so2); 32892719Salfredint socreate(int dom, struct socket **aso, int type, int proto, 32992719Salfred struct ucred *cred, struct thread *td); 33092719Salfredint sodisconnect(struct socket *so); 331126425Srwatsonstruct sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags); 33292719Salfredvoid sofree(struct socket *so); 33392719Salfredvoid sohasoutofband(struct socket *so); 33492719Salfredint solisten(struct socket *so, int backlog, struct thread *td); 335151888Srwatsonvoid solisten_proto(struct socket *so, int backlog); 336142190Srwatsonint solisten_proto_check(struct socket *so); 33714505Shsustruct socket * 33892719Salfred sonewconn(struct socket *head, int connstatus); 33953541Sshin 34053541Sshin 341101983Srwatsonint sopoll(struct socket *so, int events, struct ucred *active_cred, 34293008Sbde struct thread *td); 343160619Srwatsonint sopoll_generic(struct socket *so, int events, 344160619Srwatson struct ucred *active_cred, struct thread *td); 34593008Sbdeint soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio, 34693008Sbde struct mbuf **mp0, struct mbuf **controlp, int *flagsp); 347194672Sandreint soreceive_stream(struct socket *so, struct sockaddr **paddr, 348194672Sandre struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 349194672Sandre int *flagsp); 350180198Srwatsonint soreceive_dgram(struct socket *so, struct sockaddr **paddr, 351180198Srwatson struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 352180198Srwatson int *flagsp); 353160619Srwatsonint soreceive_generic(struct socket *so, struct sockaddr **paddr, 354160619Srwatson struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 355160619Srwatson int *flagsp); 35692719Salfredint soreserve(struct socket *so, u_long sndcc, u_long rcvcc); 35792719Salfredvoid sorflush(struct socket *so); 35892719Salfredint sosend(struct socket *so, struct sockaddr *addr, struct uio *uio, 35993008Sbde struct mbuf *top, struct mbuf *control, int flags, 36093008Sbde struct thread *td); 361154294Srwatsonint sosend_dgram(struct socket *so, struct sockaddr *addr, 362154294Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 363154294Srwatson int flags, struct thread *td); 364160619Srwatsonint sosend_generic(struct socket *so, struct sockaddr *addr, 365160619Srwatson struct uio *uio, struct mbuf *top, struct mbuf *control, 366160619Srwatson int flags, struct thread *td); 36792719Salfredint soshutdown(struct socket *so, int how); 36892719Salfredvoid sotoxsocket(struct socket *so, struct xsocket *xso); 369193272Sjhbvoid soupcall_clear(struct socket *so, int which); 370193272Sjhbvoid soupcall_set(struct socket *so, int which, 371193272Sjhb int (*func)(struct socket *, void *, int), void *arg); 37292719Salfredvoid sowakeup(struct socket *so, struct sockbuf *sb); 373252356Sdavideint selsocket(struct socket *so, int events, struct timeval *tv, 374252356Sdavide struct thread *td); 37531927Sbde 37695959Salfred/* 37795959Salfred * Accept filter functions (duh). 37895959Salfred */ 37992719Salfredint accept_filt_add(struct accept_filter *filt); 38092719Salfredint accept_filt_del(char *name); 38195959Salfredstruct accept_filter *accept_filt_get(char *name); 38261837Salfred#ifdef ACCEPT_FILTER_MOD 38395959Salfred#ifdef SYSCTL_DECL 38465534SalfredSYSCTL_DECL(_net_inet_accf); 38595959Salfred#endif 38695959Salfredint accept_filt_generic_mod_event(module_t mod, int event, void *data); 38795959Salfred#endif 38861837Salfred 38955205Speter#endif /* _KERNEL */ 3902165Spaul 39114505Shsu#endif /* !_SYS_SOCKETVAR_H_ */ 392