1 /*- 2 * Copyright (c) 1982, 1986, 1990 The Regents of the University of California. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * $Id$ 34 */ 35 36 #include "sys/socket.h" 37 38 /* 39 * Kernel structure per socket. 40 * Contains send and receive buffer queues, 41 * handle on protocol and pointer to protocol 42 * private data and error information. 43 */ 44 struct socket { 45 short so_type; /* generic type, see socket.h */ 46 short so_options; /* from socket call, see socket.h */ 47 short so_linger; /* time to linger while closing */ 48 short so_state; /* internal state flags SS_*, below */ 49 caddr_t so_pcb; /* protocol control block */ 50 struct protosw *so_proto; /* protocol handle */ 51 /* 52 * Variables for connection queueing. 53 * Socket where accepts occur is so_head in all subsidiary sockets. 54 * If so_head is 0, socket is not related to an accept. 55 * For head socket so_q0 queues partially completed connections, 56 * while so_q is a queue of connections ready to be accepted. 57 * If a connection is aborted and it has so_head set, then 58 * it has to be pulled out of either so_q0 or so_q. 59 * We allow connections to queue up based on current queue lengths 60 * and limit on number of queued connections for this socket. 61 */ 62 struct socket *so_head; /* back pointer to accept socket */ 63 struct socket *so_q0; /* queue of partial connections */ 64 struct socket *so_q; /* queue of incoming connections */ 65 short so_q0len; /* partials on so_q0 */ 66 short so_qlen; /* number of connections on so_q */ 67 short so_qlimit; /* max number queued connections */ 68 short so_timeo; /* connection timeout */ 69 u_short so_error; /* error affecting connection */ 70 pid_t so_pgid; /* pgid for signals */ 71 u_long so_oobmark; /* chars to oob mark */ 72 /* 73 * Variables for socket buffering. 74 */ 75 struct sockbuf { 76 u_long sb_cc; /* actual chars in buffer */ 77 u_long sb_hiwat; /* max actual char count */ 78 u_long sb_mbcnt; /* chars of mbufs used */ 79 u_long sb_mbmax; /* max chars of mbufs to use */ 80 long sb_lowat; /* low water mark */ 81 struct mbuf *sb_mb; /* the mbuf chain */ 82 pid_t sb_sel; /* process selecting read/write */ 83 short sb_flags; /* flags, see below */ 84 short sb_timeo; /* timeout for read/write */ 85 } so_rcv, so_snd; 86 #define SB_MAX (64*1024) /* default for max chars in sockbuf */ 87 #define SB_LOCK 0x01 /* lock on data queue */ 88 #define SB_WANT 0x02 /* someone is waiting to lock */ 89 #define SB_WAIT 0x04 /* someone is waiting for data/space */ 90 #define SB_SEL 0x08 /* someone is selecting */ 91 #define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 92 #define SB_NOTIFY (SB_WAIT|SB_SEL|SB_ASYNC) 93 #define SB_COLL 0x20 /* collision selecting */ 94 #define SB_NOINTR 0x40 /* operations not interruptible */ 95 96 caddr_t so_tpcb; /* Wisc. protocol control block XXX */ 97 }; 98 99 /* 100 * Socket state bits. 101 */ 102 #define SS_NOFDREF 0x001 /* no file table ref any more */ 103 #define SS_ISCONNECTED 0x002 /* socket connected to a peer */ 104 #define SS_ISCONNECTING 0x004 /* in process of connecting to peer */ 105 #define SS_ISDISCONNECTING 0x008 /* in process of disconnecting */ 106 #define SS_CANTSENDMORE 0x010 /* can't send more data to peer */ 107 #define SS_CANTRCVMORE 0x020 /* can't receive more data from peer */ 108 #define SS_RCVATMARK 0x040 /* at mark on input */ 109 110 #define SS_PRIV 0x080 /* privileged for broadcast, raw... */ 111 #define SS_NBIO 0x100 /* non-blocking ops */ 112 #define SS_ASYNC 0x200 /* async i/o notify */ 113 #define SS_ISCONFIRMING 0x400 /* deciding to accept connection req */ 114 115 116 /* 117 * Macros for sockets and socket buffering. 118 */ 119 120 /* 121 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 122 * This is problematical if the fields are unsigned, as the space might 123 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 124 * overflow and return 0. Should use "lmin" but it doesn't exist now. 125 */ 126 #define sbspace(sb) \ 127 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 128 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 129 130 /* do we have to send all at once on a socket? */ 131 #define sosendallatonce(so) \ 132 ((so)->so_proto->pr_flags & PR_ATOMIC) 133 134 /* can we read something from so? */ 135 #define soreadable(so) \ 136 ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 137 ((so)->so_state & SS_CANTRCVMORE) || \ 138 (so)->so_qlen || (so)->so_error) 139 140 /* can we write something to so? */ 141 #define sowriteable(so) \ 142 (sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 143 (((so)->so_state&SS_ISCONNECTED) || \ 144 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0) || \ 145 ((so)->so_state & SS_CANTSENDMORE) || \ 146 (so)->so_error) 147 148 /* adjust counters in sb reflecting allocation of m */ 149 #define sballoc(sb, m) { \ 150 (sb)->sb_cc += (m)->m_len; \ 151 (sb)->sb_mbcnt += MSIZE; \ 152 if ((m)->m_flags & M_EXT) \ 153 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 154 } 155 156 /* adjust counters in sb reflecting freeing of m */ 157 #define sbfree(sb, m) { \ 158 (sb)->sb_cc -= (m)->m_len; \ 159 (sb)->sb_mbcnt -= MSIZE; \ 160 if ((m)->m_flags & M_EXT) \ 161 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 162 } 163 164 /* 165 * Set lock on sockbuf sb; sleep if lock is already held. 166 * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 167 * Returns error without lock if sleep is interrupted. 168 */ 169 #define sblock(sb) ((sb)->sb_flags & SB_LOCK ? sb_lock(sb) : \ 170 ((sb)->sb_flags |= SB_LOCK, 0)) 171 172 /* release lock on sockbuf sb */ 173 #define sbunlock(sb) { \ 174 (sb)->sb_flags &= ~SB_LOCK; \ 175 if ((sb)->sb_flags & SB_WANT) { \ 176 (sb)->sb_flags &= ~SB_WANT; \ 177 wakeup((caddr_t)&(sb)->sb_flags); \ 178 } \ 179 } 180 181 #define sorwakeup(so) sowakeup((so), &(so)->so_rcv) 182 #define sowwakeup(so) sowakeup((so), &(so)->so_snd) 183 184 #ifdef KERNEL 185 u_long sb_max; 186 /* to catch callers missing new second argument to sonewconn: */ 187 #define sonewconn(head, connstatus) sonewconn1((head), (connstatus)) 188 struct socket *sonewconn1 __P((struct socket *head, int connstatus)); 189 190 /* strings for sleep message: */ 191 extern char netio[], netcon[], netcls[]; 192 193 /* 194 * File operations on sockets. 195 */ 196 int soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred)); 197 int soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred)); 198 int soo_ioctl __P((struct file *fp, int com, caddr_t data, struct proc *p)); 199 int soo_select __P((struct file *fp, int which, struct proc *p)); 200 int soo_close __P((struct file *fp, struct proc *p)); 201 202 void sowakeup(struct socket *so, struct sockbuf *sb); 203 #endif 204