socketvar.h revision 1541
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 * 331541Srgrimes * @(#)socketvar.h 8.1 (Berkeley) 6/2/93 341541Srgrimes */ 351541Srgrimes 361541Srgrimes#include <sys/select.h> /* for struct selinfo */ 371541Srgrimes 381541Srgrimes/* 391541Srgrimes * Kernel structure per socket. 401541Srgrimes * Contains send and receive buffer queues, 411541Srgrimes * handle on protocol and pointer to protocol 421541Srgrimes * private data and error information. 431541Srgrimes */ 441541Srgrimesstruct socket { 451541Srgrimes short so_type; /* generic type, see socket.h */ 461541Srgrimes short so_options; /* from socket call, see socket.h */ 471541Srgrimes short so_linger; /* time to linger while closing */ 481541Srgrimes short so_state; /* internal state flags SS_*, below */ 491541Srgrimes caddr_t so_pcb; /* protocol control block */ 501541Srgrimes struct protosw *so_proto; /* protocol handle */ 511541Srgrimes/* 521541Srgrimes * Variables for connection queueing. 531541Srgrimes * Socket where accepts occur is so_head in all subsidiary sockets. 541541Srgrimes * If so_head is 0, socket is not related to an accept. 551541Srgrimes * For head socket so_q0 queues partially completed connections, 561541Srgrimes * while so_q is a queue of connections ready to be accepted. 571541Srgrimes * If a connection is aborted and it has so_head set, then 581541Srgrimes * it has to be pulled out of either so_q0 or so_q. 591541Srgrimes * We allow connections to queue up based on current queue lengths 601541Srgrimes * and limit on number of queued connections for this socket. 611541Srgrimes */ 621541Srgrimes struct socket *so_head; /* back pointer to accept socket */ 631541Srgrimes struct socket *so_q0; /* queue of partial connections */ 641541Srgrimes struct socket *so_q; /* queue of incoming connections */ 651541Srgrimes short so_q0len; /* partials on so_q0 */ 661541Srgrimes short so_qlen; /* number of connections on so_q */ 671541Srgrimes short so_qlimit; /* max number queued connections */ 681541Srgrimes short so_timeo; /* connection timeout */ 691541Srgrimes u_short so_error; /* error affecting connection */ 701541Srgrimes pid_t so_pgid; /* pgid for signals */ 711541Srgrimes u_long so_oobmark; /* chars to oob mark */ 721541Srgrimes/* 731541Srgrimes * Variables for socket buffering. 741541Srgrimes */ 751541Srgrimes struct sockbuf { 761541Srgrimes u_long sb_cc; /* actual chars in buffer */ 771541Srgrimes u_long sb_hiwat; /* max actual char count */ 781541Srgrimes u_long sb_mbcnt; /* chars of mbufs used */ 791541Srgrimes u_long sb_mbmax; /* max chars of mbufs to use */ 801541Srgrimes long sb_lowat; /* low water mark */ 811541Srgrimes struct mbuf *sb_mb; /* the mbuf chain */ 821541Srgrimes struct selinfo sb_sel; /* process selecting read/write */ 831541Srgrimes short sb_flags; /* flags, see below */ 841541Srgrimes short sb_timeo; /* timeout for read/write */ 851541Srgrimes } so_rcv, so_snd; 861541Srgrimes#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 871541Srgrimes#define SB_LOCK 0x01 /* lock on data queue */ 881541Srgrimes#define SB_WANT 0x02 /* someone is waiting to lock */ 891541Srgrimes#define SB_WAIT 0x04 /* someone is waiting for data/space */ 901541Srgrimes#define SB_SEL 0x08 /* someone is selecting */ 911541Srgrimes#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 921541Srgrimes#define SB_NOTIFY (SB_WAIT|SB_SEL|SB_ASYNC) 931541Srgrimes#define SB_NOINTR 0x40 /* operations not interruptible */ 941541Srgrimes 951541Srgrimes caddr_t so_tpcb; /* Wisc. protocol control block XXX */ 961541Srgrimes void (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf)); 971541Srgrimes caddr_t so_upcallarg; /* Arg for above */ 981541Srgrimes}; 991541Srgrimes 1001541Srgrimes/* 1011541Srgrimes * Socket state bits. 1021541Srgrimes */ 1031541Srgrimes#define SS_NOFDREF 0x001 /* no file table ref any more */ 1041541Srgrimes#define SS_ISCONNECTED 0x002 /* socket connected to a peer */ 1051541Srgrimes#define SS_ISCONNECTING 0x004 /* in process of connecting to peer */ 1061541Srgrimes#define SS_ISDISCONNECTING 0x008 /* in process of disconnecting */ 1071541Srgrimes#define SS_CANTSENDMORE 0x010 /* can't send more data to peer */ 1081541Srgrimes#define SS_CANTRCVMORE 0x020 /* can't receive more data from peer */ 1091541Srgrimes#define SS_RCVATMARK 0x040 /* at mark on input */ 1101541Srgrimes 1111541Srgrimes#define SS_PRIV 0x080 /* privileged for broadcast, raw... */ 1121541Srgrimes#define SS_NBIO 0x100 /* non-blocking ops */ 1131541Srgrimes#define SS_ASYNC 0x200 /* async i/o notify */ 1141541Srgrimes#define SS_ISCONFIRMING 0x400 /* deciding to accept connection req */ 1151541Srgrimes 1161541Srgrimes 1171541Srgrimes/* 1181541Srgrimes * Macros for sockets and socket buffering. 1191541Srgrimes */ 1201541Srgrimes 1211541Srgrimes/* 1221541Srgrimes * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 1231541Srgrimes * This is problematical if the fields are unsigned, as the space might 1241541Srgrimes * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 1251541Srgrimes * overflow and return 0. Should use "lmin" but it doesn't exist now. 1261541Srgrimes */ 1271541Srgrimes#define sbspace(sb) \ 1281541Srgrimes ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 1291541Srgrimes (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 1301541Srgrimes 1311541Srgrimes/* do we have to send all at once on a socket? */ 1321541Srgrimes#define sosendallatonce(so) \ 1331541Srgrimes ((so)->so_proto->pr_flags & PR_ATOMIC) 1341541Srgrimes 1351541Srgrimes/* can we read something from so? */ 1361541Srgrimes#define soreadable(so) \ 1371541Srgrimes ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 1381541Srgrimes ((so)->so_state & SS_CANTRCVMORE) || \ 1391541Srgrimes (so)->so_qlen || (so)->so_error) 1401541Srgrimes 1411541Srgrimes/* can we write something to so? */ 1421541Srgrimes#define sowriteable(so) \ 1431541Srgrimes (sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 1441541Srgrimes (((so)->so_state&SS_ISCONNECTED) || \ 1451541Srgrimes ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0) || \ 1461541Srgrimes ((so)->so_state & SS_CANTSENDMORE) || \ 1471541Srgrimes (so)->so_error) 1481541Srgrimes 1491541Srgrimes/* adjust counters in sb reflecting allocation of m */ 1501541Srgrimes#define sballoc(sb, m) { \ 1511541Srgrimes (sb)->sb_cc += (m)->m_len; \ 1521541Srgrimes (sb)->sb_mbcnt += MSIZE; \ 1531541Srgrimes if ((m)->m_flags & M_EXT) \ 1541541Srgrimes (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 1551541Srgrimes} 1561541Srgrimes 1571541Srgrimes/* adjust counters in sb reflecting freeing of m */ 1581541Srgrimes#define sbfree(sb, m) { \ 1591541Srgrimes (sb)->sb_cc -= (m)->m_len; \ 1601541Srgrimes (sb)->sb_mbcnt -= MSIZE; \ 1611541Srgrimes if ((m)->m_flags & M_EXT) \ 1621541Srgrimes (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 1631541Srgrimes} 1641541Srgrimes 1651541Srgrimes/* 1661541Srgrimes * Set lock on sockbuf sb; sleep if lock is already held. 1671541Srgrimes * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 1681541Srgrimes * Returns error without lock if sleep is interrupted. 1691541Srgrimes */ 1701541Srgrimes#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 1711541Srgrimes (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 1721541Srgrimes ((sb)->sb_flags |= SB_LOCK), 0) 1731541Srgrimes 1741541Srgrimes/* release lock on sockbuf sb */ 1751541Srgrimes#define sbunlock(sb) { \ 1761541Srgrimes (sb)->sb_flags &= ~SB_LOCK; \ 1771541Srgrimes if ((sb)->sb_flags & SB_WANT) { \ 1781541Srgrimes (sb)->sb_flags &= ~SB_WANT; \ 1791541Srgrimes wakeup((caddr_t)&(sb)->sb_flags); \ 1801541Srgrimes } \ 1811541Srgrimes} 1821541Srgrimes 1831541Srgrimes#define sorwakeup(so) { sowakeup((so), &(so)->so_rcv); \ 1841541Srgrimes if ((so)->so_upcall) \ 1851541Srgrimes (*((so)->so_upcall))((so), (so)->so_upcallarg, M_DONTWAIT); \ 1861541Srgrimes } 1871541Srgrimes 1881541Srgrimes#define sowwakeup(so) sowakeup((so), &(so)->so_snd) 1891541Srgrimes 1901541Srgrimes#ifdef KERNEL 1911541Srgrimesu_long sb_max; 1921541Srgrimes/* to catch callers missing new second argument to sonewconn: */ 1931541Srgrimes#define sonewconn(head, connstatus) sonewconn1((head), (connstatus)) 1941541Srgrimesstruct socket *sonewconn1 __P((struct socket *head, int connstatus)); 1951541Srgrimes 1961541Srgrimes/* strings for sleep message: */ 1971541Srgrimesextern char netio[], netcon[], netcls[]; 1981541Srgrimes 1991541Srgrimes/* 2001541Srgrimes * File operations on sockets. 2011541Srgrimes */ 2021541Srgrimesint soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred)); 2031541Srgrimesint soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred)); 2041541Srgrimesint soo_ioctl __P((struct file *fp, int com, caddr_t data, struct proc *p)); 2051541Srgrimesint soo_select __P((struct file *fp, int which, struct proc *p)); 2061541Srgrimesint soo_close __P((struct file *fp, struct proc *p)); 2071541Srgrimes#endif 208