]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/socketvar.h
xnu-344.49.tar.gz
[apple/xnu.git] / bsd / sys / socketvar.h
index d9e2b7be53ee84e59b443ede8cbdeca23a222a90..e60037bba632df760b8fc3e68a95e4397b02746e 100644 (file)
@@ -1,21 +1,24 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
  * @APPLE_LICENSE_HEADER_END@
  */
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- *     @(#)socketvar.h 8.1 (Berkeley) 6/2/93
+ *     @(#)socketvar.h 8.3 (Berkeley) 2/19/95
+ * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.6 2001/08/31 13:45:49 jlemon Exp $
  */
 
-#ifndef        _SYS_SOCKETVAR_H_
+#ifndef _SYS_SOCKETVAR_H_
 #define _SYS_SOCKETVAR_H_
 
+#include <sys/appleapiopts.h>
+#include <sys/queue.h>                 /* for TAILQ macros */
 #include <sys/select.h>                        /* for struct selinfo */
-#include <sys/queue.h>
 #include <net/kext_net.h>
 #include <sys/ev.h>
 /*
  * Hacks to get around compiler complaints
  */
 struct mbuf;
-struct socket;
-struct uio;
-struct sockbuf;
-struct sockaddr;
 struct kextcb;
 struct protosw;
 struct sockif;
 struct sockutil;
 
 /* strings for sleep message: */
+#ifdef __APPLE_API_UNSTABLE
 extern char netio[], netcon[], netcls[];
 #define SOCKET_CACHE_ON        
 #define SO_CACHE_FLUSH_INTERVAL 1      /* Seconds */
@@ -93,22 +95,27 @@ extern      char netio[], netcon[], netcls[];
  */
 typedef        u_quad_t so_gen_t;
 
+#ifndef __APPLE__
+/* We don't support BSD style socket filters */
+struct accept_filter;
+#endif
+
 struct socket {
-       int     so_zone;        /* zone we were allocated from */
-       short   so_type;                /* generic type, see socket.h */
+       int             so_zone;                        /* zone we were allocated from */
+       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 */
+       short   so_state;                       /* internal state flags SS_*, below */
        caddr_t so_pcb;                 /* protocol control block */
        struct  protosw *so_proto;      /* protocol handle */
 /*
- * Variables for connection queueing.
+ * Variables for connection queuing.
  * 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.
+ * For head socket so_incomp queues partially completed connections,
+ * while so_comp 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.
+ * it has to be pulled out of either so_incomp or so_comp.
  * We allow connections to queue up based on current queue lengths
  * and limit on number of queued connections for this socket.
  */
@@ -124,6 +131,10 @@ struct socket {
        u_short so_error;               /* error affecting connection */
        pid_t   so_pgid;                /* pgid for signals */
        u_long  so_oobmark;             /* chars to oob mark */
+#ifndef __APPLE__
+       /* We don't support AIO ops */
+       TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
+#endif
 /*
  * Variables for socket buffering.
  */
@@ -134,28 +145,46 @@ struct socket {
                u_long  sb_mbmax;       /* max chars of mbufs to use */
                long    sb_lowat;       /* low water mark */
                struct  mbuf *sb_mb;    /* the mbuf chain */
-               struct  socket *sb_so;  /* socket back ptr */
+#if __APPLE__
+        struct  socket *sb_so;  /* socket back ptr for kexts */
+#endif
                struct  selinfo sb_sel; /* process selecting read/write */
                short   sb_flags;       /* flags, see below */
                short   sb_timeo;       /* timeout for read/write */
+               void    *reserved1;     /* for future use if needed */
+               void    *reserved2;
        } 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_ASYNC                0x10            /* ASYNC I/O, need signals */
+#define        SB_UPCALL               0x20            /* someone wants an upcall */
+#define        SB_NOINTR               0x40            /* operations not interruptible */
+#ifndef __APPLE__
+#define SB_AIO         0x80            /* AIO operations queued */
+#define SB_KNOTE               0x100   /* kernel note attached */
+#else
 #define        SB_NOTIFY       (SB_WAIT|SB_SEL|SB_ASYNC)
-#define        SB_UPCALL       0x20            /* someone wants an upcall */
-#define        SB_NOINTR       0x40            /* operations not interruptible */
 #define SB_RECV                0x8000          /* this is rcv sb */
 
-       caddr_t so_tpcb;                /* Wisc. protocol control block XXX */
+       caddr_t so_tpcb;                /* Wisc. protocol control block - XXX unused? */
+#endif
+
        void    (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf));
        caddr_t so_upcallarg;           /* Arg for above */
        uid_t   so_uid;                 /* who opened the socket */
        /* NB: generation count must not be first; easiest to make it last. */
        so_gen_t so_gencnt;             /* generation count */
+#ifndef __APPLE__
+       void    *so_emuldata;           /* private data for emulators */
+       struct  so_accf { 
+               struct  accept_filter *so_accept_filter;
+               void    *so_accept_filter_arg;  /* saved filter args */
+               char    *so_accept_filter_str;  /* saved user args */
+       } *so_accf;
+#else
        TAILQ_HEAD(,eventqelt) so_evlist;
        int     cached_in_sock_layer;   /* Is socket bundled with pcb/pcb.inp_ppcb? */
        struct  socket  *cache_next;
@@ -166,7 +195,14 @@ struct socket {
        /* Plug-in support - make the socket interface overridable */
        struct  mbuf *so_tail;
        struct  kextcb *so_ext;         /* NKE hook */
+       u_long  so_flags;               /* Flags */
+#define SOF_NOSIGPIPE  0x00000001
+       void    *reserved2;
+       void    *reserved3;
+       void    *reserved4;
+#endif
 };
+#endif /* __APPLE_API_UNSTABLE */
 
 /*
  * Socket state bits.
@@ -185,6 +221,7 @@ struct socket {
 #define        SS_ISCONFIRMING         0x400   /* deciding to accept connection req */
 #define        SS_INCOMP               0x800   /* Unaccepted, incomplete connection */
 #define        SS_COMP                 0x1000  /* unaccepted, complete connection */
+#define        SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
 
 /*
  * Externalized form of struct socket used by the sysctl(3) interface.
@@ -221,85 +258,26 @@ struct    xsocket {
 /*
  * Macros for sockets and socket buffering.
  */
+#ifdef __APPLE__
+#ifdef __APPLE_API_UNSTABLE
 #define sbtoso(sb) (sb->sb_so)
 
 /*
- * 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|SB_UPCALL)) != 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_comp.tqh_first || (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.
+ * Functions for sockets and socket buffering.
+ * These are macros on FreeBSD. On Darwin the
+ * implementation is in bsd/kern/uipc_socket2.c
  */
-#define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \
-               (((wf) == M_WAIT) ? 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); \
-       } \
-}
-
-#define        sorwakeup(so)   do { \
-                         if (sb_notify(&(so)->so_rcv)) \
-                           sowakeup((so), &(so)->so_rcv); \
-                       } while (0)
-
-#define        sowwakeup(so)   do { \
-                         if (sb_notify(&(so)->so_snd)) \
-                           sowakeup((so), &(so)->so_snd); \
-                       } while (0)
-
+int            sb_notify __P((struct sockbuf *sb));
+long           sbspace __P((struct sockbuf *sb));
+int            sosendallatonce __P((struct socket *so));
+int            soreadable __P((struct socket *so));
+int            sowriteable __P((struct socket *so));
+void           sballoc __P((struct sockbuf *sb, struct mbuf *m));
+void           sbfree __P((struct sockbuf *sb, struct mbuf *m));
+int            sblock __P((struct sockbuf *sb, int wf));
+void           sbunlock __P((struct sockbuf *sb));
+void           sorwakeup __P((struct socket * so));
+void           sowwakeup __P((struct socket * so));
 
 /*
  * Socket extension mechanism: control block hooks:
@@ -318,8 +296,10 @@ struct kextcb
 };
 #define EXT_NULL       0x0             /* STATE: Not in use */
 #define sotokextcb(so) (so ? so->so_ext : 0)
+#endif /* __APPLE___ */
 
 #ifdef KERNEL
+
 /*
  * Argument structure for sosetopt et seq.  This is in the KERNEL
  * section because it will never be visible to user code.
@@ -335,14 +315,12 @@ struct sockopt {
 };
 
 #if SENDFILE
-
 struct sf_buf {
        SLIST_ENTRY(sf_buf) free_list;  /* list of free buffer slots */
        int             refcnt;         /* reference count */
        struct          vm_page *m;     /* currently mapped page */
        vm_offset_t     kva;            /* va of mapping */
 };
-
 #endif
 
 #ifdef MALLOC_DECLARE
@@ -362,19 +340,22 @@ struct sockaddr;
 struct stat;
 struct ucred;
 struct uio;
+#ifndef __APPLE
+struct knote;
+#endif
 
 /*
  * File operations on sockets.
  */
-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_read __P((struct file *fp, struct uio *uio, struct ucred *cred,
+               int flags, struct proc *p));
+int    soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred,
+               int flags, struct proc *p));
+int soo_close __P((struct file *fp, struct proc *p));
 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_stat __P((struct socket *so, struct stat *ub));
-
-int    soo_close __P((struct file *fp, struct proc *p));
-
+int    soo_select __P((struct file *fp, int which, void * wql, struct proc *p));
 
 /*
  * From uipc_socket and friends
@@ -429,7 +410,16 @@ struct socket *
 int    sooptcopyin __P((struct sockopt *sopt, void *buf, size_t len,
                         size_t minlen));
 int    sooptcopyout __P((struct sockopt *sopt, void *buf, size_t len));
-int    sopoll __P((struct socket *so, int events, struct ucred *cred));
+
+/*
+ * XXX; prepare mbuf for (__FreeBSD__ < 3) routines.
+ * Used primarily in IPSec and IPv6 code.
+ */
+int    soopt_getm __P((struct sockopt *sopt, struct mbuf **mp));
+int    soopt_mcopyin __P((struct sockopt *sopt, struct mbuf *m));
+int    soopt_mcopyout __P((struct sockopt *sopt, struct mbuf *m));
+
+int    sopoll __P((struct socket *so, int events, struct ucred *cred, void *wql));
 int    soreceive __P((struct socket *so, struct sockaddr **paddr,
                       struct uio *uio, struct mbuf **mp0,
                       struct mbuf **controlp, int *flagsp));
@@ -439,12 +429,22 @@ int       sosend __P((struct socket *so, struct sockaddr *addr, struct uio *uio,
                    struct mbuf *top, struct mbuf *control, int flags));
 
 int    sosetopt __P((struct socket *so, struct sockopt *sopt));
-
-
 int    soshutdown __P((struct socket *so, int how));
 void   sotoxsocket __P((struct socket *so, struct xsocket *xso));
 void   sowakeup __P((struct socket *so, struct sockbuf *sb));
 
+#ifndef __APPLE__
+/* accept filter functions */
+int    accept_filt_add __P((struct accept_filter *filt));
+int    accept_filt_del __P((char *name));
+struct accept_filter * accept_filt_get __P((char *name));
+#ifdef ACCEPT_FILTER_MOD
+int accept_filt_generic_mod_event __P((module_t mod, int event, void *data));
+SYSCTL_DECL(_net_inet_accf);
+#endif /* ACCEPT_FILTER_MOD */
+#endif /* !defined(__APPLE__) */
 
 #endif /* KERNEL */
+#endif /* __APPLE_API_UNSTABLE */
+
 #endif /* !_SYS_SOCKETVAR_H_ */