Annotation of Net2/sys/socketvar.h, revision 1.1.1.2

1.1       root        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:  *     @(#)socketvar.h 7.17 (Berkeley) 5/5/91
1.1.1.2 ! root       34:  *
        !            35:  * PATCHES MAGIC                LEVEL   PATCH THAT GOT US HERE
        !            36:  * --------------------         -----   ----------------------
        !            37:  * CURRENT PATCH LEVEL:         1       00061
        !            38:  * --------------------         -----   ----------------------
        !            39:  *
        !            40:  * 11 Dec 92   Williams Jolitz         Fixed tty handling
1.1       root       41:  */
                     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:  */
                     49: struct 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 queueing.
                     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:        struct  socket *so_q0;          /* queue of partial connections */
                     69:        struct  socket *so_q;           /* queue of incoming connections */
                     70:        short   so_q0len;               /* partials on so_q0 */
                     71:        short   so_qlen;                /* number of connections on so_q */
                     72:        short   so_qlimit;              /* max number queued connections */
                     73:        short   so_timeo;               /* connection timeout */
                     74:        u_short so_error;               /* error affecting connection */
                     75:        pid_t   so_pgid;                /* pgid for signals */
                     76:        u_long  so_oobmark;             /* chars to oob mark */
                     77: /*
                     78:  * Variables for socket buffering.
                     79:  */
                     80:        struct  sockbuf {
                     81:                u_long  sb_cc;          /* actual chars in buffer */
                     82:                u_long  sb_hiwat;       /* max actual char count */
                     83:                u_long  sb_mbcnt;       /* chars of mbufs used */
                     84:                u_long  sb_mbmax;       /* max chars of mbufs to use */
                     85:                long    sb_lowat;       /* low water mark */
                     86:                struct  mbuf *sb_mb;    /* the mbuf chain */
1.1.1.2 ! root       87:                pid_t   sb_sel;         /* process selecting read/write */
1.1       root       88:                short   sb_flags;       /* flags, see below */
                     89:                short   sb_timeo;       /* timeout for read/write */
                     90:        } so_rcv, so_snd;
                     91: #define        SB_MAX          (64*1024)       /* default for max chars in sockbuf */
                     92: #define        SB_LOCK         0x01            /* lock on data queue */
                     93: #define        SB_WANT         0x02            /* someone is waiting to lock */
                     94: #define        SB_WAIT         0x04            /* someone is waiting for data/space */
                     95: #define        SB_SEL          0x08            /* someone is selecting */
                     96: #define        SB_ASYNC        0x10            /* ASYNC I/O, need signals */
                     97: #define        SB_NOTIFY       (SB_WAIT|SB_SEL|SB_ASYNC)
                     98: #define        SB_COLL         0x20            /* collision selecting */
                     99: #define        SB_NOINTR       0x40            /* operations not interruptible */
                    100: 
                    101:        caddr_t so_tpcb;                /* Wisc. protocol control block XXX */
                    102: };
                    103: 
                    104: /*
                    105:  * Socket state bits.
                    106:  */
                    107: #define        SS_NOFDREF              0x001   /* no file table ref any more */
                    108: #define        SS_ISCONNECTED          0x002   /* socket connected to a peer */
                    109: #define        SS_ISCONNECTING         0x004   /* in process of connecting to peer */
                    110: #define        SS_ISDISCONNECTING      0x008   /* in process of disconnecting */
                    111: #define        SS_CANTSENDMORE         0x010   /* can't send more data to peer */
                    112: #define        SS_CANTRCVMORE          0x020   /* can't receive more data from peer */
                    113: #define        SS_RCVATMARK            0x040   /* at mark on input */
                    114: 
                    115: #define        SS_PRIV                 0x080   /* privileged for broadcast, raw... */
                    116: #define        SS_NBIO                 0x100   /* non-blocking ops */
                    117: #define        SS_ASYNC                0x200   /* async i/o notify */
                    118: #define        SS_ISCONFIRMING         0x400   /* deciding to accept connection req */
                    119: 
                    120: 
                    121: /*
                    122:  * Macros for sockets and socket buffering.
                    123:  */
                    124: 
                    125: /*
                    126:  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
                    127:  * This is problematical if the fields are unsigned, as the space might
                    128:  * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
                    129:  * overflow and return 0.  Should use "lmin" but it doesn't exist now.
                    130:  */
                    131: #define        sbspace(sb) \
                    132:     ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \
                    133:         (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))
                    134: 
                    135: /* do we have to send all at once on a socket? */
                    136: #define        sosendallatonce(so) \
                    137:     ((so)->so_proto->pr_flags & PR_ATOMIC)
                    138: 
                    139: /* can we read something from so? */
                    140: #define        soreadable(so) \
                    141:     ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \
                    142:        ((so)->so_state & SS_CANTRCVMORE) || \
                    143:        (so)->so_qlen || (so)->so_error)
                    144: 
                    145: /* can we write something to so? */
                    146: #define        sowriteable(so) \
                    147:     (sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \
                    148:        (((so)->so_state&SS_ISCONNECTED) || \
                    149:          ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0) || \
                    150:      ((so)->so_state & SS_CANTSENDMORE) || \
                    151:      (so)->so_error)
                    152: 
                    153: /* adjust counters in sb reflecting allocation of m */
                    154: #define        sballoc(sb, m) { \
                    155:        (sb)->sb_cc += (m)->m_len; \
                    156:        (sb)->sb_mbcnt += MSIZE; \
                    157:        if ((m)->m_flags & M_EXT) \
                    158:                (sb)->sb_mbcnt += (m)->m_ext.ext_size; \
                    159: }
                    160: 
                    161: /* adjust counters in sb reflecting freeing of m */
                    162: #define        sbfree(sb, m) { \
                    163:        (sb)->sb_cc -= (m)->m_len; \
                    164:        (sb)->sb_mbcnt -= MSIZE; \
                    165:        if ((m)->m_flags & M_EXT) \
                    166:                (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
                    167: }
                    168: 
                    169: /*
                    170:  * Set lock on sockbuf sb; sleep if lock is already held.
                    171:  * Unless SB_NOINTR is set on sockbuf, sleep is interruptible.
                    172:  * Returns error without lock if sleep is interrupted.
                    173:  */
                    174: #define sblock(sb) ((sb)->sb_flags & SB_LOCK ? sb_lock(sb) : \
                    175:                ((sb)->sb_flags |= SB_LOCK, 0))
                    176: 
                    177: /* release lock on sockbuf sb */
                    178: #define        sbunlock(sb) { \
                    179:        (sb)->sb_flags &= ~SB_LOCK; \
                    180:        if ((sb)->sb_flags & SB_WANT) { \
                    181:                (sb)->sb_flags &= ~SB_WANT; \
                    182:                wakeup((caddr_t)&(sb)->sb_flags); \
                    183:        } \
                    184: }
                    185: 
                    186: #define        sorwakeup(so)   sowakeup((so), &(so)->so_rcv)
                    187: #define        sowwakeup(so)   sowakeup((so), &(so)->so_snd)
                    188: 
                    189: #ifdef KERNEL
                    190: u_long sb_max;
                    191: /* to catch callers missing new second argument to sonewconn: */
                    192: #define        sonewconn(head, connstatus)     sonewconn1((head), (connstatus))
                    193: struct socket *sonewconn1 __P((struct socket *head, int connstatus));
                    194: 
                    195: /* strings for sleep message: */
                    196: extern char netio[], netcon[], netcls[];
                    197: 
                    198: /*
                    199:  * File operations on sockets.
                    200:  */
                    201: int    soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred));
                    202: int    soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred));
                    203: int    soo_ioctl __P((struct file *fp, int com, caddr_t data, struct proc *p));
                    204: int    soo_select __P((struct file *fp, int which, struct proc *p));
                    205: int    soo_close __P((struct file *fp, struct proc *p));
                    206: #endif

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.