Subversion Repositories or1k

//==========================================================================

//

//      include/sys/socketvar.h

//

//      

//

//==========================================================================

//####BSDCOPYRIGHTBEGIN####

//

// -------------------------------------------

//

// Portions of this software may have been derived from OpenBSD or other sources,

// and are covered by the appropriate copyright disclaimers included herein.

//

// -------------------------------------------

//

//####BSDCOPYRIGHTEND####

//==========================================================================

//#####DESCRIPTIONBEGIN####

//

// Author(s):    gthomas

// Contributors: gthomas

// Date:         2000-01-10

// Purpose:      

// Description:  

//              

//

//####DESCRIPTIONEND####

//

//==========================================================================

/*      $OpenBSD: socketvar.h,v 1.17 1999/12/08 06:50:24 itojun Exp $   */

/*      $NetBSD: socketvar.h,v 1.18 1996/02/09 18:25:38 christos Exp $  */

/*-

 * Copyright (c) 1982, 1986, 1990, 1993

 *      The Regents of the University of California.  All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 * 3. All advertising materials mentioning features or use of this software

 *    must display the following acknowledgement:

 *      This product includes software developed by the University of

 *      California, Berkeley and its contributors.

 * 4. Neither the name of the University nor the names of its contributors

 *    may be used to endorse or promote products derived from this software

 *    without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND

 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

 * SUCH DAMAGE.

 *

 *      @(#)socketvar.h 8.1 (Berkeley) 6/2/93

 */

#ifndef _SYS_SOCKETVAR_H_

#define _SYS_SOCKETVAR_H_

#include <sys/bsdselect.h>                      /* for struct selinfo */

/*

 * Kernel structure per socket.

 * Contains send and receive buffer queues,

 * handle on protocol and pointer to protocol

 * private data and error information.

 */

struct socket {

        short   so_type;                /* generic type, see socket.h */

        short   so_options;             /* from socket call, see socket.h */

        short   so_linger;              /* time to linger while closing */

        short   so_state;               /* internal state flags SS_*, below */

        void    *so_pcb;                /* protocol control block */

        struct  protosw *so_proto;      /* protocol handle */

/*

 * Variables for connection queueing.

 * Socket where accepts occur is so_head in all subsidiary sockets.

 * If so_head is 0, socket is not related to an accept.

 * For head socket so_q0 queues partially completed connections,

 * while so_q is a queue of connections ready to be accepted.

 * If a connection is aborted and it has so_head set, then

 * it has to be pulled out of either so_q0 or so_q.

 * We allow connections to queue up based on current queue lengths

 * and limit on number of queued connections for this socket.

 */

        struct  socket *so_head;        /* back pointer to accept socket */

        struct  socket *so_q0;          /* queue of partial connections */

        struct  socket *so_q;           /* queue of incoming connections */

        short   so_q0len;               /* partials on so_q0 */

        short   so_qlen;                /* number of connections on so_q */

        short   so_qlimit;              /* max number queued connections */

        short   so_timeo;               /* connection timeout */

        u_short so_error;               /* error affecting connection */

        pid_t   so_pgid;                /* pgid for signals */

        uid_t   so_siguid;              /* uid of process who set so_pgid */

        uid_t   so_sigeuid;             /* euid of process who set so_pgid */

        u_long  so_oobmark;             /* chars to oob mark */

/*

 * Variables for socket buffering.

 */

        struct  sockbuf {

                u_long  sb_cc;          /* actual chars in buffer */

                u_long  sb_hiwat;       /* max actual char count */

                u_long  sb_mbcnt;       /* chars of mbufs used */

                u_long  sb_mbmax;       /* max chars of mbufs to use */

                long    sb_lowat;       /* low water mark */

                struct  mbuf *sb_mb;    /* the mbuf chain */

                struct  selinfo sb_sel; /* process selecting read/write */

                short   sb_flags;       /* flags, see below */

                short   sb_timeo;       /* timeout for read/write */

        } so_rcv, so_snd;

#define SB_MAX          (256*1024)      /* default for max chars in sockbuf */

#define SB_LOCK         0x01            /* lock on data queue */

#define SB_WANT         0x02            /* someone is waiting to lock */

#define SB_WAIT         0x04            /* someone is waiting for data/space */

#define SB_SEL          0x08            /* someone is selecting */

#define SB_ASYNC        0x10            /* ASYNC I/O, need signals */

#define SB_NOINTR       0x40            /* operations not interruptible */

        void    *so_internal;           /* Space for svr4 stream data */

        void    (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf));

        caddr_t so_upcallarg;           /* Arg for above */

        uid_t   so_euid;                /* who opened the socket */

        uid_t   so_ruid;                /* who opened the socket */

};

/*

 * Socket state bits.

 */

#define SS_NOFDREF              0x001   /* no file table ref any more */

#define SS_ISCONNECTED          0x002   /* socket connected to a peer */

#define SS_ISCONNECTING         0x004   /* in process of connecting to peer */

#define SS_ISDISCONNECTING      0x008   /* in process of disconnecting */

#define SS_CANTSENDMORE         0x010   /* can't send more data to peer */

#define SS_CANTRCVMORE          0x020   /* can't receive more data from peer */

#define SS_RCVATMARK            0x040   /* at mark on input */

#define SS_ISDISCONNECTED       0x800   /* socket disconnected from peer */

#define SS_PRIV                 0x080   /* privileged for broadcast, raw... */

#define SS_NBIO                 0x100   /* non-blocking ops */

#define SS_ASYNC                0x200   /* async i/o notify */

#define SS_ISCONFIRMING         0x400   /* deciding to accept connection req */

#define SS_CONNECTOUT           0x1000  /* connect, not accept, at this end */

/*

 * Macros for sockets and socket buffering.

 */

/*

 * Do we need to notify the other side when I/O is possible?

 */

#define sb_notify(sb)   (((sb)->sb_flags & (SB_WAIT|SB_SEL|SB_ASYNC)) != 0)

/*

 * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?

 * This is problematical if the fields are unsigned, as the space might

 * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect

 * overflow and return 0.  Should use "lmin" but it doesn't exist now.

 */

#define sbspace(sb) \

    ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \

         (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))

/* do we have to send all at once on a socket? */

#define sosendallatonce(so) \

    ((so)->so_proto->pr_flags & PR_ATOMIC)

/* can we read something from so? */

#define soreadable(so) \

    ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \

        ((so)->so_state & SS_CANTRCVMORE) || \

        (so)->so_qlen || (so)->so_error)

/* can we write something to so? */

#define sowriteable(so) \

    ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \

        (((so)->so_state&SS_ISCONNECTED) || \

          ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \

     ((so)->so_state & SS_CANTSENDMORE) || \

     (so)->so_error)

/* adjust counters in sb reflecting allocation of m */

#define sballoc(sb, m) { \

        (sb)->sb_cc += (m)->m_len; \

        (sb)->sb_mbcnt += MSIZE; \

        if ((m)->m_flags & M_EXT) \

                (sb)->sb_mbcnt += (m)->m_ext.ext_size; \

}

/* adjust counters in sb reflecting freeing of m */

#define sbfree(sb, m) { \

        (sb)->sb_cc -= (m)->m_len; \

        (sb)->sb_mbcnt -= MSIZE; \

        if ((m)->m_flags & M_EXT) \

                (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \

}

/*

 * Set lock on sockbuf sb; sleep if lock is already held.

 * Unless SB_NOINTR is set on sockbuf, sleep is interruptible.

 * Returns error without lock if sleep is interrupted.

 */

#ifdef __ECOS

extern int  sblock(struct sockbuf *sb, int wf);

extern void sbunlock(struct sockbuf *sb);

#else

#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \

                (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \

                ((sb)->sb_flags |= SB_LOCK), 0)

/* release lock on sockbuf sb */

#define sbunlock(sb) { \

        (sb)->sb_flags &= ~SB_LOCK; \

        if ((sb)->sb_flags & SB_WANT) { \

                (sb)->sb_flags &= ~SB_WANT; \

                wakeup((caddr_t)&(sb)->sb_flags); \

        } \

}

#endif

#define sorwakeup(so)   { sowakeup((so), &(so)->so_rcv); \

                          if ((so)->so_upcall) \

                            (*((so)->so_upcall))((so), (so)->so_upcallarg, M_DONTWAIT); \

                        }

#define sowwakeup(so)   sowakeup((so), &(so)->so_snd)

#ifdef _KERNEL

u_long  sb_max;

/* to catch callers missing new second argument to sonewconn: */

#define sonewconn(head, connstatus)     sonewconn1((head), (connstatus))

struct  socket *sonewconn1 __P((struct socket *head, int connstatus));

/* strings for sleep message: */

extern  char netio[], netcon[], netcls[];

struct mbuf;

struct sockaddr;

struct proc;

struct msghdr;

struct stat;

/*

 * File operations on sockets.

 */

#ifdef __ECOS

int     soo_read __P((struct file *fp, struct uio *uio));

int     soo_write __P((struct file *fp, struct uio *uio));

int     soo_ioctl __P((struct file *fp, CYG_ADDRWORD cmd, CYG_ADDRWORD data));

int     soo_select __P((struct file *fp, int which));

int     soo_close __P((struct file *fp));

#else

int     soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred));

int     soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred));

int     soo_ioctl __P((struct file *fp, u_long cmd, caddr_t data,

            struct proc *p));

int     soo_select __P((struct file *fp, int which, struct proc *p));

int     soo_close __P((struct file *fp, struct proc *p));

#endif

int     soo_stat __P((struct socket *, struct stat *));

int     uipc_usrreq __P((struct socket *, int , struct mbuf *,

                         struct mbuf *, struct mbuf *));

void    sbappend __P((struct sockbuf *sb, struct mbuf *m));

int     sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa,

            struct mbuf *m0, struct mbuf *control));

int     sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0,

            struct mbuf *control));

void    sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0));

void    sbcheck __P((struct sockbuf *sb));

void    sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n));

struct mbuf *

        sbcreatecontrol __P((caddr_t p, int size, int type, int level));

void    sbdrop __P((struct sockbuf *sb, int len));

void    sbdroprecord __P((struct sockbuf *sb));

void    sbflush __P((struct sockbuf *sb));

void    sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0));

void    sbrelease __P((struct sockbuf *sb));

int     sbreserve __P((struct sockbuf *sb, u_long cc));

int     sbwait __P((struct sockbuf *sb));

int     sb_lock __P((struct sockbuf *sb));

int     soabort __P((struct socket *so));

int     soaccept __P((struct socket *so, struct mbuf *nam));

int     sobind __P((struct socket *so, struct mbuf *nam));

void    socantrcvmore __P((struct socket *so));

void    socantsendmore __P((struct socket *so));

int     soclose __P((struct socket *so));

int     soconnect __P((struct socket *so, struct mbuf *nam));

int     soconnect2 __P((struct socket *so1, struct socket *so2));

int     socreate __P((int dom, struct socket **aso, int type, int proto));

int     sodisconnect __P((struct socket *so));

void    sofree __P((struct socket *so));

int     sogetopt __P((struct socket *so, int level, int optname,

            struct mbuf **mp));

void    sohasoutofband __P((struct socket *so));

void    soisconnected __P((struct socket *so));

void    soisconnecting __P((struct socket *so));

void    soisdisconnected __P((struct socket *so));

void    soisdisconnecting __P((struct socket *so));

int     solisten __P((struct socket *so, int backlog));

struct socket *

        sonewconn1 __P((struct socket *head, int connstatus));

void    soqinsque __P((struct socket *head, struct socket *so, int q));

int     soqremque __P((struct socket *so, int q));

int     soreceive __P((struct socket *so, struct mbuf **paddr, struct uio *uio,

                       struct mbuf **mp0, struct mbuf **controlp, int *flagsp));

int     soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc));

void    sorflush __P((struct socket *so));

int     sosend __P((struct socket *so, struct mbuf *addr, struct uio *uio,

            struct mbuf *top, struct mbuf *control, int flags));

int     sosetopt __P((struct socket *so, int level, int optname,

            struct mbuf *m0));

int     soshutdown __P((struct socket *so, int how));

void    sowakeup __P((struct socket *so, struct sockbuf *sb));

int     sockargs __P((struct mbuf **, caddr_t, socklen_t, int));

#ifdef __ECOS

int     sendit __P((int, struct msghdr *, int, register_t *));

int     recvit __P((int, struct msghdr *, caddr_t, register_t *));

#else

int     sendit __P((struct proc *, int, struct msghdr *, int, register_t *));

int     recvit __P((struct proc *, int, struct msghdr *, caddr_t,

                    register_t *));

#endif

#endif /* _KERNEL */

#endif // _SYS_SOCKETVAR_H_