socketvar.h revision 14505
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 3414505Shsu * $Id: socketvar.h,v 1.16 1996/02/29 00:07:13 hsu Exp $ 351541Srgrimes */ 361541Srgrimes 372165Spaul#ifndef _SYS_SOCKETVAR_H_ 382165Spaul#define _SYS_SOCKETVAR_H_ 392165Spaul 403304Sphk#include <sys/stat.h> /* for struct stat */ 413304Sphk#include <sys/filedesc.h> /* for struct filedesc */ 421541Srgrimes#include <sys/select.h> /* for struct selinfo */ 431541Srgrimes 441541Srgrimes/* 451541Srgrimes * Kernel structure per socket. 461541Srgrimes * Contains send and receive buffer queues, 471541Srgrimes * handle on protocol and pointer to protocol 481541Srgrimes * private data and error information. 491541Srgrimes */ 501541Srgrimesstruct socket { 511541Srgrimes short so_type; /* generic type, see socket.h */ 521541Srgrimes short so_options; /* from socket call, see socket.h */ 531541Srgrimes short so_linger; /* time to linger while closing */ 541541Srgrimes short so_state; /* internal state flags SS_*, below */ 551541Srgrimes caddr_t so_pcb; /* protocol control block */ 561541Srgrimes struct protosw *so_proto; /* protocol handle */ 571541Srgrimes/* 5813765Smpp * Variables for connection queuing. 591541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets. 601541Srgrimes * If so_head is 0, socket is not related to an accept. 611541Srgrimes * For head socket so_q0 queues partially completed connections, 621541Srgrimes * while so_q is a queue of connections ready to be accepted. 631541Srgrimes * If a connection is aborted and it has so_head set, then 641541Srgrimes * it has to be pulled out of either so_q0 or so_q. 651541Srgrimes * We allow connections to queue up based on current queue lengths 661541Srgrimes * and limit on number of queued connections for this socket. 671541Srgrimes */ 681541Srgrimes struct socket *so_head; /* back pointer to accept socket */ 691541Srgrimes struct socket *so_q0; /* queue of partial connections */ 701541Srgrimes struct socket *so_q; /* queue of incoming connections */ 711541Srgrimes short so_q0len; /* partials on so_q0 */ 721541Srgrimes short so_qlen; /* number of connections on so_q */ 731541Srgrimes short so_qlimit; /* max number queued connections */ 741541Srgrimes short so_timeo; /* connection timeout */ 751541Srgrimes u_short so_error; /* error affecting connection */ 761541Srgrimes pid_t so_pgid; /* pgid for signals */ 771541Srgrimes u_long so_oobmark; /* chars to oob mark */ 781541Srgrimes/* 791541Srgrimes * Variables for socket buffering. 801541Srgrimes */ 811541Srgrimes struct sockbuf { 821541Srgrimes u_long sb_cc; /* actual chars in buffer */ 831541Srgrimes u_long sb_hiwat; /* max actual char count */ 841541Srgrimes u_long sb_mbcnt; /* chars of mbufs used */ 851541Srgrimes u_long sb_mbmax; /* max chars of mbufs to use */ 861541Srgrimes long sb_lowat; /* low water mark */ 871541Srgrimes struct mbuf *sb_mb; /* the mbuf chain */ 881541Srgrimes struct selinfo sb_sel; /* process selecting read/write */ 891541Srgrimes short sb_flags; /* flags, see below */ 901541Srgrimes short sb_timeo; /* timeout for read/write */ 911541Srgrimes } so_rcv, so_snd; 921541Srgrimes#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 931541Srgrimes#define SB_LOCK 0x01 /* lock on data queue */ 941541Srgrimes#define SB_WANT 0x02 /* someone is waiting to lock */ 951541Srgrimes#define SB_WAIT 0x04 /* someone is waiting for data/space */ 961541Srgrimes#define SB_SEL 0x08 /* someone is selecting */ 971541Srgrimes#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 981541Srgrimes#define SB_NOTIFY (SB_WAIT|SB_SEL|SB_ASYNC) 991541Srgrimes#define SB_NOINTR 0x40 /* operations not interruptible */ 1001541Srgrimes 1011541Srgrimes caddr_t so_tpcb; /* Wisc. protocol control block XXX */ 1021541Srgrimes void (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf)); 1031541Srgrimes caddr_t so_upcallarg; /* Arg for above */ 1041541Srgrimes}; 1051541Srgrimes 1061541Srgrimes/* 1071541Srgrimes * Socket state bits. 1081541Srgrimes */ 1091541Srgrimes#define SS_NOFDREF 0x001 /* no file table ref any more */ 1101541Srgrimes#define SS_ISCONNECTED 0x002 /* socket connected to a peer */ 1111541Srgrimes#define SS_ISCONNECTING 0x004 /* in process of connecting to peer */ 1121541Srgrimes#define SS_ISDISCONNECTING 0x008 /* in process of disconnecting */ 1131541Srgrimes#define SS_CANTSENDMORE 0x010 /* can't send more data to peer */ 1141541Srgrimes#define SS_CANTRCVMORE 0x020 /* can't receive more data from peer */ 1151541Srgrimes#define SS_RCVATMARK 0x040 /* at mark on input */ 1161541Srgrimes 1171541Srgrimes#define SS_PRIV 0x080 /* privileged for broadcast, raw... */ 1181541Srgrimes#define SS_NBIO 0x100 /* non-blocking ops */ 1191541Srgrimes#define SS_ASYNC 0x200 /* async i/o notify */ 1201541Srgrimes#define SS_ISCONFIRMING 0x400 /* deciding to accept connection req */ 1211541Srgrimes 1221541Srgrimes 1231541Srgrimes/* 1241541Srgrimes * Macros for sockets and socket buffering. 1251541Srgrimes */ 1261541Srgrimes 1271541Srgrimes/* 1281541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 1291541Srgrimes * This is problematical if the fields are unsigned, as the space might 1301541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 1311541Srgrimes * overflow and return 0. Should use "lmin" but it doesn't exist now. 1321541Srgrimes */ 1331541Srgrimes#define sbspace(sb) \ 1341541Srgrimes ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 1351541Srgrimes (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 1361541Srgrimes 1371541Srgrimes/* do we have to send all at once on a socket? */ 1381541Srgrimes#define sosendallatonce(so) \ 1391541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 1401541Srgrimes 1411541Srgrimes/* can we read something from so? */ 1421541Srgrimes#define soreadable(so) \ 1431541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 1441541Srgrimes ((so)->so_state & SS_CANTRCVMORE) || \ 1451541Srgrimes (so)->so_qlen || (so)->so_error) 1461541Srgrimes 1471541Srgrimes/* can we write something to so? */ 1481541Srgrimes#define sowriteable(so) \ 1493304Sphk ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 1501541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 1513304Sphk ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 1521541Srgrimes ((so)->so_state & SS_CANTSENDMORE) || \ 1531541Srgrimes (so)->so_error) 1541541Srgrimes 1551541Srgrimes/* adjust counters in sb reflecting allocation of m */ 1561541Srgrimes#define sballoc(sb, m) { \ 1571541Srgrimes (sb)->sb_cc += (m)->m_len; \ 1581541Srgrimes (sb)->sb_mbcnt += MSIZE; \ 1591541Srgrimes if ((m)->m_flags & M_EXT) \ 1601541Srgrimes (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 1611541Srgrimes} 1621541Srgrimes 1631541Srgrimes/* adjust counters in sb reflecting freeing of m */ 1641541Srgrimes#define sbfree(sb, m) { \ 1651541Srgrimes (sb)->sb_cc -= (m)->m_len; \ 1661541Srgrimes (sb)->sb_mbcnt -= MSIZE; \ 1671541Srgrimes if ((m)->m_flags & M_EXT) \ 1681541Srgrimes (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 1691541Srgrimes} 1701541Srgrimes 1711541Srgrimes/* 1721541Srgrimes * Set lock on sockbuf sb; sleep if lock is already held. 1731541Srgrimes * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 1741541Srgrimes * Returns error without lock if sleep is interrupted. 1751541Srgrimes */ 1761541Srgrimes#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 1771541Srgrimes (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 1781541Srgrimes ((sb)->sb_flags |= SB_LOCK), 0) 1791541Srgrimes 1801541Srgrimes/* release lock on sockbuf sb */ 1811541Srgrimes#define sbunlock(sb) { \ 1821541Srgrimes (sb)->sb_flags &= ~SB_LOCK; \ 1831541Srgrimes if ((sb)->sb_flags & SB_WANT) { \ 1841541Srgrimes (sb)->sb_flags &= ~SB_WANT; \ 1851541Srgrimes wakeup((caddr_t)&(sb)->sb_flags); \ 1861541Srgrimes } \ 1871541Srgrimes} 1881541Srgrimes 1891541Srgrimes#define sorwakeup(so) { sowakeup((so), &(so)->so_rcv); \ 1901541Srgrimes if ((so)->so_upcall) \ 1911541Srgrimes (*((so)->so_upcall))((so), (so)->so_upcallarg, M_DONTWAIT); \ 1921541Srgrimes } 1931541Srgrimes 1941541Srgrimes#define sowwakeup(so) sowakeup((so), &(so)->so_snd) 1951541Srgrimes 1961541Srgrimes#ifdef KERNEL 1972112Swollmanextern u_long sb_max; 19814505Shsu 1991541Srgrimes/* to catch callers missing new second argument to sonewconn: */ 2001541Srgrimes#define sonewconn(head, connstatus) sonewconn1((head), (connstatus)) 2011541Srgrimes 2021541Srgrimes/* 2031541Srgrimes * File operations on sockets. 2041541Srgrimes */ 20514505Shsuint soo_ioctl __P((struct file *fp, int cmd, caddr_t data, 20614505Shsu struct proc *p)); 2071541Srgrimesint soo_select __P((struct file *fp, int which, struct proc *p)); 20814505Shsuint soo_stat __P((struct socket *so, struct stat *ub)); 2093304Sphk 21014505Shsustruct mbuf; 21114505Shsustruct sockaddr; 21214505Shsu 2133304Sphk/* 2143304Sphk * From uipc_socket and friends 2153304Sphk */ 21614505Shsuint getsock __P((struct filedesc *fdp, int fdes, struct file **fpp)); 21714505Shsuint sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type)); 21814505Shsuvoid sbappend __P((struct sockbuf *sb, struct mbuf *m)); 21914505Shsuint sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa, 22014505Shsu struct mbuf *m0, struct mbuf *control)); 22114505Shsuint sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0, 22214505Shsu struct mbuf *control)); 22314505Shsuvoid sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0)); 22414505Shsuvoid sbcheck __P((struct sockbuf *sb)); 22514505Shsuvoid sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n)); 22614505Shsuvoid sbdrop __P((struct sockbuf *sb, int len)); 22714505Shsuvoid sbdroprecord __P((struct sockbuf *sb)); 22814505Shsuvoid sbflush __P((struct sockbuf *sb)); 22914505Shsuvoid sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0)); 23014505Shsuvoid sbrelease __P((struct sockbuf *sb)); 23114505Shsuint sbreserve __P((struct sockbuf *sb, u_long cc)); 23214505Shsuint sbwait __P((struct sockbuf *sb)); 23314505Shsuint sb_lock __P((struct sockbuf *sb)); 23414505Shsuint soabort __P((struct socket *so)); 23514505Shsuint soaccept __P((struct socket *so, struct mbuf *nam)); 23614505Shsuint sobind __P((struct socket *so, struct mbuf *nam)); 23714505Shsuvoid socantrcvmore __P((struct socket *so)); 23814505Shsuvoid socantsendmore __P((struct socket *so)); 23914505Shsuint soclose __P((struct socket *so)); 24014505Shsuint soconnect __P((struct socket *so, struct mbuf *nam)); 24114505Shsuint soconnect2 __P((struct socket *so1, struct socket *so2)); 24214505Shsuint socreate __P((int dom, struct socket **aso, int type, int proto, 24314505Shsu struct proc *p)); 24414505Shsuint sodisconnect __P((struct socket *so)); 24514505Shsuvoid sofree __P((struct socket *so)); 24614505Shsuint sogetopt __P((struct socket *so, int level, int optname, 24714505Shsu struct mbuf **mp)); 24814505Shsuvoid sohasoutofband __P((struct socket *so)); 24914505Shsuvoid soisconnected __P((struct socket *so)); 25014505Shsuvoid soisconnecting __P((struct socket *so)); 25114505Shsuvoid soisdisconnected __P((struct socket *so)); 25214505Shsuvoid soisdisconnecting __P((struct socket *so)); 25314505Shsuint solisten __P((struct socket *so, int backlog)); 25414505Shsustruct socket * 25514505Shsu sonewconn1 __P((struct socket *head, int connstatus)); 25614505Shsuvoid soqinsque __P((struct socket *head, struct socket *so, int q)); 25714505Shsuint soqremque __P((struct socket *so, int q)); 25814505Shsuint soreceive __P((struct socket *so, struct mbuf **paddr, struct uio *uio, 25914505Shsu struct mbuf **mp0, struct mbuf **controlp, int *flagsp)); 26014505Shsuint soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc)); 26114505Shsuvoid sorflush __P((struct socket *so)); 26214505Shsuint sosend __P((struct socket *so, struct mbuf *addr, struct uio *uio, 26314505Shsu struct mbuf *top, struct mbuf *control, int flags)); 26414505Shsuint sosetopt __P((struct socket *so, int level, int optname, 26514505Shsu struct mbuf *m0)); 26614505Shsuint soshutdown __P((struct socket *so, int how)); 26714505Shsuvoid sowakeup __P((struct socket *so, struct sockbuf *sb)); 26814505Shsu#endif /* KERNEL */ 2692165Spaul 27014505Shsu#endif /* !_SYS_SOCKETVAR_H_ */ 271