socketvar.h revision 25201
1/*- 2 * Copyright (c) 1982, 1986, 1990, 1993 3 * The Regents of the University of California. 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 * @(#)socketvar.h 8.3 (Berkeley) 2/19/95 34 * $Id: socketvar.h,v 1.18 1997/02/22 09:45:56 peter Exp $ 35 */ 36 37#ifndef _SYS_SOCKETVAR_H_ 38#define _SYS_SOCKETVAR_H_ 39 40#include <sys/queue.h> /* for TAILQ macros */ 41#include <sys/select.h> /* for struct selinfo */ 42 43/* 44 * Kernel structure per socket. 45 * Contains send and receive buffer queues, 46 * handle on protocol and pointer to protocol 47 * private data and error information. 48 */ 49struct socket { 50 short so_type; /* generic type, see socket.h */ 51 short so_options; /* from socket call, see socket.h */ 52 short so_linger; /* time to linger while closing */ 53 short so_state; /* internal state flags SS_*, below */ 54 caddr_t so_pcb; /* protocol control block */ 55 struct protosw *so_proto; /* protocol handle */ 56/* 57 * Variables for connection queuing. 58 * Socket where accepts occur is so_head in all subsidiary sockets. 59 * If so_head is 0, socket is not related to an accept. 60 * For head socket so_q0 queues partially completed connections, 61 * while so_q is a queue of connections ready to be accepted. 62 * If a connection is aborted and it has so_head set, then 63 * it has to be pulled out of either so_q0 or so_q. 64 * We allow connections to queue up based on current queue lengths 65 * and limit on number of queued connections for this socket. 66 */ 67 struct socket *so_head; /* back pointer to accept socket */ 68 TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */ 69 TAILQ_HEAD(, socket) so_comp; /* queue of complete unaccepted connections */ 70 TAILQ_ENTRY(socket) so_list; /* list of unaccepted connections */ 71 short so_qlen; /* number of unaccepted connections */ 72 short so_incqlen; /* number of unaccepted incomplete 73 connections */ 74 short so_qlimit; /* max number queued connections */ 75 short so_timeo; /* connection timeout */ 76 u_short so_error; /* error affecting connection */ 77 pid_t so_pgid; /* pgid for signals */ 78 u_long so_oobmark; /* chars to oob mark */ 79/* 80 * Variables for socket buffering. 81 */ 82 struct sockbuf { 83 u_long sb_cc; /* actual chars in buffer */ 84 u_long sb_hiwat; /* max actual char count */ 85 u_long sb_mbcnt; /* chars of mbufs used */ 86 u_long sb_mbmax; /* max chars of mbufs to use */ 87 long sb_lowat; /* low water mark */ 88 struct mbuf *sb_mb; /* the mbuf chain */ 89 struct selinfo sb_sel; /* process selecting read/write */ 90 short sb_flags; /* flags, see below */ 91 short sb_timeo; /* timeout for read/write */ 92 } so_rcv, so_snd; 93#define SB_MAX (256*1024) /* default for max chars in sockbuf */ 94#define SB_LOCK 0x01 /* lock on data queue */ 95#define SB_WANT 0x02 /* someone is waiting to lock */ 96#define SB_WAIT 0x04 /* someone is waiting for data/space */ 97#define SB_SEL 0x08 /* someone is selecting */ 98#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ 99#define SB_NOTIFY (SB_WAIT|SB_SEL|SB_ASYNC) 100#define SB_NOINTR 0x40 /* operations not interruptible */ 101 102 caddr_t so_tpcb; /* Wisc. protocol control block XXX */ 103 void (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf)); 104 caddr_t so_upcallarg; /* Arg for above */ 105}; 106 107/* 108 * Socket state bits. 109 */ 110#define SS_NOFDREF 0x0001 /* no file table ref any more */ 111#define SS_ISCONNECTED 0x0002 /* socket connected to a peer */ 112#define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */ 113#define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */ 114#define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */ 115#define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */ 116#define SS_RCVATMARK 0x0040 /* at mark on input */ 117 118/*efine SS_PRIV 0x0080 privileged for broadcast, raw... */ 119#define SS_NBIO 0x0100 /* non-blocking ops */ 120#define SS_ASYNC 0x0200 /* async i/o notify */ 121#define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */ 122 123#define SS_INCOMP 0x0800 /* unaccepted, incomplete connection */ 124#define SS_COMP 0x1000 /* unaccepted, complete connection */ 125 126 127/* 128 * Macros for sockets and socket buffering. 129 */ 130 131/* 132 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)? 133 * This is problematical if the fields are unsigned, as the space might 134 * still be negative (cc > hiwat or mbcnt > mbmax). Should detect 135 * overflow and return 0. Should use "lmin" but it doesn't exist now. 136 */ 137#define sbspace(sb) \ 138 ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \ 139 (int)((sb)->sb_mbmax - (sb)->sb_mbcnt))) 140 141/* do we have to send all at once on a socket? */ 142#define sosendallatonce(so) \ 143 ((so)->so_proto->pr_flags & PR_ATOMIC) 144 145/* can we read something from so? */ 146#define soreadable(so) \ 147 ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \ 148 ((so)->so_state & SS_CANTRCVMORE) || \ 149 (so)->so_comp.tqh_first || (so)->so_error) 150 151/* can we write something to so? */ 152#define sowriteable(so) \ 153 ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \ 154 (((so)->so_state&SS_ISCONNECTED) || \ 155 ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \ 156 ((so)->so_state & SS_CANTSENDMORE) || \ 157 (so)->so_error) 158 159/* adjust counters in sb reflecting allocation of m */ 160#define sballoc(sb, m) { \ 161 (sb)->sb_cc += (m)->m_len; \ 162 (sb)->sb_mbcnt += MSIZE; \ 163 if ((m)->m_flags & M_EXT) \ 164 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \ 165} 166 167/* adjust counters in sb reflecting freeing of m */ 168#define sbfree(sb, m) { \ 169 (sb)->sb_cc -= (m)->m_len; \ 170 (sb)->sb_mbcnt -= MSIZE; \ 171 if ((m)->m_flags & M_EXT) \ 172 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \ 173} 174 175/* 176 * Set lock on sockbuf sb; sleep if lock is already held. 177 * Unless SB_NOINTR is set on sockbuf, sleep is interruptible. 178 * Returns error without lock if sleep is interrupted. 179 */ 180#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \ 181 (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \ 182 ((sb)->sb_flags |= SB_LOCK), 0) 183 184/* release lock on sockbuf sb */ 185#define sbunlock(sb) { \ 186 (sb)->sb_flags &= ~SB_LOCK; \ 187 if ((sb)->sb_flags & SB_WANT) { \ 188 (sb)->sb_flags &= ~SB_WANT; \ 189 wakeup((caddr_t)&(sb)->sb_flags); \ 190 } \ 191} 192 193#define sorwakeup(so) { sowakeup((so), &(so)->so_rcv); \ 194 if ((so)->so_upcall) \ 195 (*((so)->so_upcall))((so), (so)->so_upcallarg, M_DONTWAIT); \ 196 } 197 198#define sowwakeup(so) sowakeup((so), &(so)->so_snd) 199 200#ifdef KERNEL 201extern u_long sb_max; 202 203/* to catch callers missing new second argument to sonewconn: */ 204#define sonewconn(head, connstatus) sonewconn1((head), (connstatus)) 205 206struct filedesc; 207struct mbuf; 208struct sockaddr; 209struct stat; 210 211/* 212 * File operations on sockets. 213 */ 214int soo_ioctl __P((struct file *fp, int cmd, caddr_t data, 215 struct proc *p)); 216int soo_select __P((struct file *fp, int which, struct proc *p)); 217int soo_stat __P((struct socket *so, struct stat *ub)); 218 219/* 220 * From uipc_socket and friends 221 */ 222int getsock __P((struct filedesc *fdp, int fdes, struct file **fpp)); 223int sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type)); 224void sbappend __P((struct sockbuf *sb, struct mbuf *m)); 225int sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa, 226 struct mbuf *m0, struct mbuf *control)); 227int sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0, 228 struct mbuf *control)); 229void sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0)); 230void sbcheck __P((struct sockbuf *sb)); 231void sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n)); 232struct mbuf * 233 sbcreatecontrol __P((caddr_t p, int size, int type, int level)); 234void sbdrop __P((struct sockbuf *sb, int len)); 235void sbdroprecord __P((struct sockbuf *sb)); 236void sbflush __P((struct sockbuf *sb)); 237void sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0)); 238void sbrelease __P((struct sockbuf *sb)); 239int sbreserve __P((struct sockbuf *sb, u_long cc)); 240int sbwait __P((struct sockbuf *sb)); 241int sb_lock __P((struct sockbuf *sb)); 242int soabort __P((struct socket *so)); 243int soaccept __P((struct socket *so, struct mbuf *nam)); 244int sobind __P((struct socket *so, struct mbuf *nam, struct proc *p)); 245void socantrcvmore __P((struct socket *so)); 246void socantsendmore __P((struct socket *so)); 247int soclose __P((struct socket *so)); 248int soconnect __P((struct socket *so, struct mbuf *nam, struct proc *p)); 249int soconnect2 __P((struct socket *so1, struct socket *so2)); 250int socreate __P((int dom, struct socket **aso, int type, int proto, 251 struct proc *p)); 252int sodisconnect __P((struct socket *so)); 253void sofree __P((struct socket *so)); 254int sogetopt __P((struct socket *so, int level, int optname, 255 struct mbuf **mp, struct proc *p)); 256void sohasoutofband __P((struct socket *so)); 257void soisconnected __P((struct socket *so)); 258void soisconnecting __P((struct socket *so)); 259void soisdisconnected __P((struct socket *so)); 260void soisdisconnecting __P((struct socket *so)); 261int solisten __P((struct socket *so, int backlog, struct proc *p)); 262struct socket * 263 sodropablereq __P((struct socket *head)); 264struct socket * 265 sonewconn1 __P((struct socket *head, int connstatus)); 266int soreceive __P((struct socket *so, struct mbuf **paddr, struct uio *uio, 267 struct mbuf **mp0, struct mbuf **controlp, int *flagsp)); 268int soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc)); 269void sorflush __P((struct socket *so)); 270int soselect __P((struct socket *so, int which, struct proc *p)); 271int sosend __P((struct socket *so, struct mbuf *addr, struct uio *uio, 272 struct mbuf *top, struct mbuf *control, int flags)); 273int sosetopt __P((struct socket *so, int level, int optname, 274 struct mbuf *m0, struct proc *p)); 275int soshutdown __P((struct socket *so, int how)); 276void sowakeup __P((struct socket *so, struct sockbuf *sb)); 277#endif /* KERNEL */ 278 279#endif /* !_SYS_SOCKETVAR_H_ */ 280