socketvar.h revision 36527
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 * 3. All advertising materials mentioning features or use of this software 141541Srgrimes * must display the following acknowledgement: 151541Srgrimes * This product includes software developed by the University of 161541Srgrimes * California, Berkeley and its contributors. 171541Srgrimes * 4. Neither the name of the University nor the names of its contributors 181541Srgrimes * may be used to endorse or promote products derived from this software 191541Srgrimes * without specific prior written permission. 201541Srgrimes * 211541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 291541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311541Srgrimes * SUCH DAMAGE. 321541Srgrimes * 3314505Shsu * @(#)socketvar.h 8.3 (Berkeley) 2/19/95 3436527Speter * $Id: socketvar.h,v 1.26 1998/05/15 20:11:39 wollman Exp $ 351541Srgrimes */ 361541Srgrimes 372165Spaul#ifndef _SYS_SOCKETVAR_H_ 382165Spaul#define _SYS_SOCKETVAR_H_ 392165Spaul 4015492Sbde#include <sys/queue.h> /* for TAILQ macros */ 411541Srgrimes#include <sys/select.h> /* for struct selinfo */ 421541Srgrimes 431541Srgrimes/* 441541Srgrimes * Kernel structure per socket. 451541Srgrimes * Contains send and receive buffer queues, 461541Srgrimes * handle on protocol and pointer to protocol 471541Srgrimes * private data and error information. 481541Srgrimes */ 4936079Swollmantypedef u_quad_t so_gen_t; 5036079Swollman 511541Srgrimesstruct socket { 5236079Swollman struct vm_zone *so_zone; /* zone we were allocated from */ 531541Srgrimes short so_type; /* generic type, see socket.h */ 541541Srgrimes short so_options; /* from socket call, see socket.h */ 551541Srgrimes short so_linger; /* time to linger while closing */ 561541Srgrimes short so_state; /* internal state flags SS_*, below */ 571541Srgrimes caddr_t so_pcb; /* protocol control block */ 581541Srgrimes struct protosw *so_proto; /* protocol handle */ 591541Srgrimes/* 6013765Smpp * Variables for connection queuing. 611541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets. 621541Srgrimes * If so_head is 0, socket is not related to an accept. 631541Srgrimes * For head socket so_q0 queues partially completed connections, 641541Srgrimes * while so_q is a queue of connections ready to be accepted. 651541Srgrimes * If a connection is aborted and it has so_head set, then 661541Srgrimes * it has to be pulled out of either so_q0 or so_q. 671541Srgrimes * We allow connections to queue up based on current queue lengths 681541Srgrimes * and limit on number of queued connections for this socket. 691541Srgrimes */ 701541Srgrimes struct socket *so_head; /* back pointer to accept socket */ 7114547Sdg TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */ 7214547Sdg TAILQ_HEAD(, socket) so_comp; /* queue of complete unaccepted connections */ 7314547Sdg TAILQ_ENTRY(socket) so_list; /* list of unaccepted connections */ 7414547Sdg short so_qlen; /* number of unaccepted connections */ 7518787Spst short so_incqlen; /* number of unaccepted incomplete 7618787Spst connections */ 771541Srgrimes short so_qlimit; /* max number queued connections */ 781541Srgrimes short so_timeo; /* connection timeout */ 791541Srgrimes u_short so_error; /* error affecting connection */ 801541Srgrimes pid_t so_pgid; /* pgid for signals */ 811541Srgrimes u_long so_oobmark; /* chars to oob mark */ 821541Srgrimes/* 831541Srgrimes * Variables for socket buffering. 841541Srgrimes */ 851541Srgrimes struct sockbuf { 861541Srgrimes u_long sb_cc; /* actual chars in buffer */ 871541Srgrimes u_long sb_hiwat; /* max actual char count */ 881541Srgrimes u_long sb_mbcnt; /* chars of mbufs used */ 891541Srgrimes u_long sb_mbmax; /* max chars of mbufs to use */ 901541Srgrimes long sb_lowat; /* low water mark */ 911541Srgrimes struct mbuf *sb_mb; /* the mbuf chain */ 921541Srgrimes struct selinfo sb_sel; /* process selecting read/write */ 931541Srgrimes short sb_flags; /* flags, see below */ 941541Srgrimes short sb_timeo; /* timeout for read/write */ 951541Srgrimes } so_rcv, so_snd; 961541Srgrimes#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 971541Srgrimes#define SB_LOCK 0x01 /* lock on data queue */ 981541Srgrimes#define SB_WANT 0x02 /* someone is waiting to lock */ 991541Srgrimes#define SB_WAIT 0x04 /* someone is waiting for data/space */ 1001541Srgrimes#define SB_SEL 0x08 /* someone is selecting */ 1011541Srgrimes#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 10236527Speter#define SB_UPCALL 0x20 /* someone wants an upcall */ 1031541Srgrimes#define SB_NOINTR 0x40 /* operations not interruptible */ 1041541Srgrimes 1051541Srgrimes void (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf)); 1061541Srgrimes caddr_t so_upcallarg; /* Arg for above */ 10733955Sguido uid_t so_uid; /* who opened the socket */ 10836079Swollman so_gen_t so_gencnt; /* generation count */ 1091541Srgrimes}; 1101541Srgrimes 1111541Srgrimes/* 1121541Srgrimes * Socket state bits. 1131541Srgrimes */ 11414547Sdg#define SS_NOFDREF 0x0001 /* no file table ref any more */ 11514547Sdg#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 11614547Sdg#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 11714547Sdg#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 11814547Sdg#define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 11914547Sdg#define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 12014547Sdg#define SS_RCVATMARK 0x0040 /* at mark on input */ 1211541Srgrimes 12225201Swollman/*efine SS_PRIV 0x0080 privileged for broadcast, raw... */ 12314547Sdg#define SS_NBIO 0x0100 /* non-blocking ops */ 12414547Sdg#define SS_ASYNC 0x0200 /* async i/o notify */ 12514547Sdg#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 1261541Srgrimes 12714547Sdg#define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */ 12814547Sdg#define SS_COMP 0x1000 /* unaccepted, complete connection */ 1291541Srgrimes 13036079Swollman/* 13136079Swollman * Externalized form of struct socket used by the sysctl(3) interface. 13236079Swollman */ 13336079Swollmanstruct xsocket { 13436079Swollman size_t xso_len; /* length of this structure */ 13536079Swollman struct socket *xso_so; /* makes a convenient handle sometimes */ 13636079Swollman short so_type; 13736079Swollman short so_options; 13836079Swollman short so_linger; 13936079Swollman short so_state; 14036079Swollman caddr_t so_pcb; /* another convenient handle */ 14136079Swollman int xso_protocol; 14236079Swollman int xso_family; 14336079Swollman short so_qlen; 14436079Swollman short so_incqlen; 14536079Swollman short so_qlimit; 14636079Swollman short so_timeo; 14736079Swollman u_short so_error; 14836079Swollman pid_t so_pgid; 14936079Swollman u_long so_oobmark; 15036079Swollman struct xsockbuf { 15136079Swollman u_long sb_cc; 15236079Swollman u_long sb_hiwat; 15336079Swollman u_long sb_mbcnt; 15436079Swollman u_long sb_mbmax; 15536079Swollman long sb_lowat; 15636079Swollman short sb_flags; 15736079Swollman short sb_timeo; 15836079Swollman } so_rcv, so_snd; 15936079Swollman uid_t so_uid; /* XXX */ 16036079Swollman}; 16114547Sdg 1621541Srgrimes/* 1631541Srgrimes * Macros for sockets and socket buffering. 1641541Srgrimes */ 1651541Srgrimes 1661541Srgrimes/* 16736527Speter * Do we need to notify the other side when I/O is possible? 16836527Speter */ 16936527Speter#define sb_notify(sb) (((sb)->sb_flags & (SB_WAIT|SB_SEL|SB_ASYNC|SB_UPCALL)) != 0) 17036527Speter 17136527Speter/* 1721541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 1731541Srgrimes * This is problematical if the fields are unsigned, as the space might 1741541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 1751541Srgrimes * overflow and return 0. Should use "lmin" but it doesn't exist now. 1761541Srgrimes */ 1771541Srgrimes#define sbspace(sb) \ 1781541Srgrimes ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 1791541Srgrimes (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 1801541Srgrimes 1811541Srgrimes/* do we have to send all at once on a socket? */ 1821541Srgrimes#define sosendallatonce(so) \ 1831541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 1841541Srgrimes 1851541Srgrimes/* can we read something from so? */ 1861541Srgrimes#define soreadable(so) \ 1871541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 1881541Srgrimes ((so)->so_state & SS_CANTRCVMORE) || \ 18914547Sdg (so)->so_comp.tqh_first || (so)->so_error) 1901541Srgrimes 1911541Srgrimes/* can we write something to so? */ 1921541Srgrimes#define sowriteable(so) \ 1933304Sphk ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 1941541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 1953304Sphk ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 1961541Srgrimes ((so)->so_state & SS_CANTSENDMORE) || \ 1971541Srgrimes (so)->so_error) 1981541Srgrimes 1991541Srgrimes/* adjust counters in sb reflecting allocation of m */ 2001541Srgrimes#define sballoc(sb, m) { \ 2011541Srgrimes (sb)->sb_cc += (m)->m_len; \ 2021541Srgrimes (sb)->sb_mbcnt += MSIZE; \ 2031541Srgrimes if ((m)->m_flags & M_EXT) \ 2041541Srgrimes (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 2051541Srgrimes} 2061541Srgrimes 2071541Srgrimes/* adjust counters in sb reflecting freeing of m */ 2081541Srgrimes#define sbfree(sb, m) { \ 2091541Srgrimes (sb)->sb_cc -= (m)->m_len; \ 2101541Srgrimes (sb)->sb_mbcnt -= MSIZE; \ 2111541Srgrimes if ((m)->m_flags & M_EXT) \ 2121541Srgrimes (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 2131541Srgrimes} 2141541Srgrimes 2151541Srgrimes/* 2161541Srgrimes * Set lock on sockbuf sb; sleep if lock is already held. 2171541Srgrimes * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 2181541Srgrimes * Returns error without lock if sleep is interrupted. 2191541Srgrimes */ 2201541Srgrimes#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 2211541Srgrimes (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 2221541Srgrimes ((sb)->sb_flags |= SB_LOCK), 0) 2231541Srgrimes 2241541Srgrimes/* release lock on sockbuf sb */ 2251541Srgrimes#define sbunlock(sb) { \ 2261541Srgrimes (sb)->sb_flags &= ~SB_LOCK; \ 2271541Srgrimes if ((sb)->sb_flags & SB_WANT) { \ 2281541Srgrimes (sb)->sb_flags &= ~SB_WANT; \ 2291541Srgrimes wakeup((caddr_t)&(sb)->sb_flags); \ 2301541Srgrimes } \ 2311541Srgrimes} 2321541Srgrimes 23336527Speter#define sorwakeup(so) do { \ 23436527Speter if (sb_notify(&(so)->so_rcv)) \ 23536527Speter sowakeup((so), &(so)->so_rcv); \ 23636527Speter } while (0) 2371541Srgrimes 23836527Speter#define sowwakeup(so) do { \ 23936527Speter if (sb_notify(&(so)->so_snd)) \ 24036527Speter sowakeup((so), &(so)->so_snd); \ 24136527Speter } while (0) 2421541Srgrimes 2431541Srgrimes#ifdef KERNEL 24431927Sbde 24531927Sbde#ifdef MALLOC_DECLARE 24631927SbdeMALLOC_DECLARE(M_PCB); 24731927SbdeMALLOC_DECLARE(M_SONAME); 24831927Sbde#endif 24931927Sbde 25036079Swollmanextern int maxsockets; 2512112Swollmanextern u_long sb_max; 25236079Swollmanextern struct vm_zone *socket_zone; 25336079Swollmanextern so_gen_t so_gencnt; 25414505Shsu 25532995Sbdestruct file; 25615492Sbdestruct filedesc; 25715492Sbdestruct mbuf; 25815492Sbdestruct sockaddr; 25915492Sbdestruct stat; 26032995Sbdestruct ucred; 26132995Sbdestruct uio; 26215492Sbde 2631541Srgrimes/* 2641541Srgrimes * File operations on sockets. 2651541Srgrimes */ 26614505Shsuint soo_ioctl __P((struct file *fp, int cmd, caddr_t data, 26714505Shsu struct proc *p)); 26829350Speterint soo_poll __P((struct file *fp, int events, struct ucred *cred, 26929350Speter struct proc *p)); 27014505Shsuint soo_stat __P((struct socket *so, struct stat *ub)); 2713304Sphk 2723304Sphk/* 2733304Sphk * From uipc_socket and friends 2743304Sphk */ 27528270Swollmanstruct sockaddr *dup_sockaddr __P((struct sockaddr *sa, int canwait)); 27614505Shsuint getsock __P((struct filedesc *fdp, int fdes, struct file **fpp)); 27714505Shsuint sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type)); 27828270Swollmanint getsockaddr __P((struct sockaddr **namp, caddr_t uaddr, size_t len)); 27914505Shsuvoid sbappend __P((struct sockbuf *sb, struct mbuf *m)); 28014505Shsuint sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa, 28114505Shsu struct mbuf *m0, struct mbuf *control)); 28214505Shsuint sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0, 28314505Shsu struct mbuf *control)); 28414505Shsuvoid sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0)); 28514505Shsuvoid sbcheck __P((struct sockbuf *sb)); 28614505Shsuvoid sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n)); 28719670Sbdestruct mbuf * 28819670Sbde sbcreatecontrol __P((caddr_t p, int size, int type, int level)); 28914505Shsuvoid sbdrop __P((struct sockbuf *sb, int len)); 29014505Shsuvoid sbdroprecord __P((struct sockbuf *sb)); 29114505Shsuvoid sbflush __P((struct sockbuf *sb)); 29214505Shsuvoid sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0)); 29314505Shsuvoid sbrelease __P((struct sockbuf *sb)); 29414505Shsuint sbreserve __P((struct sockbuf *sb, u_long cc)); 29536079Swollmanvoid sbtoxsockbuf __P((struct sockbuf *sb, struct xsockbuf *xsb)); 29614505Shsuint sbwait __P((struct sockbuf *sb)); 29714505Shsuint sb_lock __P((struct sockbuf *sb)); 29814505Shsuint soabort __P((struct socket *so)); 29928270Swollmanint soaccept __P((struct socket *so, struct sockaddr **nam)); 30036079Swollmanstruct socket *soalloc __P((int waitok)); 30128270Swollmanint sobind __P((struct socket *so, struct sockaddr *nam, struct proc *p)); 30214505Shsuvoid socantrcvmore __P((struct socket *so)); 30314505Shsuvoid socantsendmore __P((struct socket *so)); 30414505Shsuint soclose __P((struct socket *so)); 30528270Swollmanint soconnect __P((struct socket *so, struct sockaddr *nam, struct proc *p)); 30614505Shsuint soconnect2 __P((struct socket *so1, struct socket *so2)); 30714505Shsuint socreate __P((int dom, struct socket **aso, int type, int proto, 30814505Shsu struct proc *p)); 30936079Swollmanvoid sodealloc __P((struct socket *so)); 31014505Shsuint sodisconnect __P((struct socket *so)); 31114505Shsuvoid sofree __P((struct socket *so)); 31214505Shsuint sogetopt __P((struct socket *so, int level, int optname, 31325201Swollman struct mbuf **mp, struct proc *p)); 31414505Shsuvoid sohasoutofband __P((struct socket *so)); 31514505Shsuvoid soisconnected __P((struct socket *so)); 31614505Shsuvoid soisconnecting __P((struct socket *so)); 31714505Shsuvoid soisdisconnected __P((struct socket *so)); 31814505Shsuvoid soisdisconnecting __P((struct socket *so)); 31925201Swollmanint solisten __P((struct socket *so, int backlog, struct proc *p)); 32014505Shsustruct socket * 32118787Spst sodropablereq __P((struct socket *head)); 32218787Spststruct socket * 32327531Sfenner sonewconn __P((struct socket *head, int connstatus)); 32429350Speterint sopoll __P((struct socket *so, int events, struct ucred *cred, 32529350Speter struct proc *p)); 32628270Swollmanint soreceive __P((struct socket *so, struct sockaddr **paddr, 32728270Swollman struct uio *uio, struct mbuf **mp0, 32828270Swollman struct mbuf **controlp, int *flagsp)); 32914505Shsuint soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc)); 33014505Shsuvoid sorflush __P((struct socket *so)); 33128270Swollmanint sosend __P((struct socket *so, struct sockaddr *addr, struct uio *uio, 33228270Swollman struct mbuf *top, struct mbuf *control, int flags, 33328270Swollman struct proc *p)); 33414505Shsuint sosetopt __P((struct socket *so, int level, int optname, 33525201Swollman struct mbuf *m0, struct proc *p)); 33614505Shsuint soshutdown __P((struct socket *so, int how)); 33736079Swollmanvoid sotoxsocket __P((struct socket *so, struct xsocket *xso)); 33814505Shsuvoid sowakeup __P((struct socket *so, struct sockbuf *sb)); 33931927Sbde 34014505Shsu#endif /* KERNEL */ 3412165Spaul 34214505Shsu#endif /* !_SYS_SOCKETVAR_H_ */ 343