bsd/sys/socketvar.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
  23 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  24 /*-
  25  * Copyright (c) 1982, 1986, 1990, 1993
  26  *      The Regents of the University of California.  All rights reserved.
  27  *
  28  * Redistribution and use in source and binary forms, with or without
  29  * modification, are permitted provided that the following conditions
  30  * are met:
  31  * 1. Redistributions of source code must retain the above copyright
  32  *    notice, this list of conditions and the following disclaimer.
  33  * 2. Redistributions in binary form must reproduce the above copyright
  34  *    notice, this list of conditions and the following disclaimer in the
  35  *    documentation and/or other materials provided with the distribution.
  36  * 3. All advertising materials mentioning features or use of this software
  37  *    must display the following acknowledgement:
  38  *      This product includes software developed by the University of
  39  *      California, Berkeley and its contributors.
  40  * 4. Neither the name of the University nor the names of its contributors
  41  *    may be used to endorse or promote products derived from this software
  42  *    without specific prior written permission.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  *
  56  *      @(#)socketvar.h 8.3 (Berkeley) 2/19/95
  57  * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.6 2001/08/31 13:45:49 jlemon Exp $
  58  */
  59
  60 #ifndef _SYS_SOCKETVAR_H_
  61 #define _SYS_SOCKETVAR_H_
  62
  63 #include <sys/appleapiopts.h>
  64 #include <sys/queue.h>                  /* for TAILQ macros */
  65 #include <sys/select.h>                 /* for struct selinfo */
  66 #include <net/kext_net.h>
  67 #include <sys/ev.h>
  68 /*
  69  * Hacks to get around compiler complaints
  70  */
  71 struct mbuf;
  72 struct kextcb;
  73 struct protosw;
  74 struct sockif;
  75 struct sockutil;
  76
  77 /* strings for sleep message: */
  78 #ifdef __APPLE_API_UNSTABLE
  79 extern  char netio[], netcon[], netcls[];
  80 #define SOCKET_CACHE_ON
  81 #define SO_CACHE_FLUSH_INTERVAL 1       /* Seconds */
  82 #define SO_CACHE_TIME_LIMIT     (120/SO_CACHE_FLUSH_INTERVAL) /* Seconds */
  83 #define SO_CACHE_MAX_FREE_BATCH 50
  84 #define MAX_CACHED_SOCKETS      60000
  85 #define TEMPDEBUG               0
  86
  87 /*
  88  * Kernel structure per socket.
  89  * Contains send and receive buffer queues,
  90  * handle on protocol and pointer to protocol
  91  * private data and error information.
  92  */
  93 typedef u_quad_t so_gen_t;
  94
  95 #ifndef __APPLE__
  96 /* We don't support BSD style socket filters */
  97 struct accept_filter;
  98 #endif
  99
 100 struct socket {
 101         int             so_zone;                        /* zone we were allocated from */
 102         short   so_type;                        /* generic type, see socket.h */
 103         short   so_options;             /* from socket call, see socket.h */
 104         short   so_linger;              /* time to linger while closing */
 105         short   so_state;                       /* internal state flags SS_*, below */
 106         caddr_t so_pcb;                 /* protocol control block */
 107         struct  protosw *so_proto;      /* protocol handle */
 108 /*
 109  * Variables for connection queuing.
 110  * Socket where accepts occur is so_head in all subsidiary sockets.
 111  * If so_head is 0, socket is not related to an accept.
 112  * For head socket so_incomp queues partially completed connections,
 113  * while so_comp is a queue of connections ready to be accepted.
 114  * If a connection is aborted and it has so_head set, then
 115  * it has to be pulled out of either so_incomp or so_comp.
 116  * We allow connections to queue up based on current queue lengths
 117  * and limit on number of queued connections for this socket.
 118  */
 119         struct  socket *so_head;        /* back pointer to accept socket */
 120         TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */
 121         TAILQ_HEAD(, socket) so_comp;   /* queue of complete unaccepted connections */
 122         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
 123         short   so_qlen;                /* number of unaccepted connections */
 124         short   so_incqlen;             /* number of unaccepted incomplete
 125                                            connections */
 126         short   so_qlimit;              /* max number queued connections */
 127         short   so_timeo;               /* connection timeout */
 128         u_short so_error;               /* error affecting connection */
 129         pid_t   so_pgid;                /* pgid for signals */
 130         u_long  so_oobmark;             /* chars to oob mark */
 131 #ifndef __APPLE__
 132         /* We don't support AIO ops */
 133         TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
 134 #endif
 135 /*
 136  * Variables for socket buffering.
 137  */
 138         struct  sockbuf {
 139                 u_long  sb_cc;          /* actual chars in buffer */
 140                 u_long  sb_hiwat;       /* max actual char count */
 141                 u_long  sb_mbcnt;       /* chars of mbufs used */
 142                 u_long  sb_mbmax;       /* max chars of mbufs to use */
 143                 long    sb_lowat;       /* low water mark */
 144                 struct  mbuf *sb_mb;    /* the mbuf chain */
 145 #if __APPLE__
 146         struct  socket *sb_so;  /* socket back ptr for kexts */
 147 #endif
 148                 struct  selinfo sb_sel; /* process selecting read/write */
 149                 short   sb_flags;       /* flags, see below */
 150                 short   sb_timeo;       /* timeout for read/write */
 151                 void    *reserved1;     /* for future use if needed */
 152                 void    *reserved2;
 153         } so_rcv, so_snd;
 154 #define SB_MAX          (256*1024)      /* default for max chars in sockbuf */
 155 #define SB_LOCK         0x01            /* lock on data queue */
 156 #define SB_WANT         0x02            /* someone is waiting to lock */
 157 #define SB_WAIT         0x04            /* someone is waiting for data/space */
 158 #define SB_SEL          0x08            /* someone is selecting */
 159 #define SB_ASYNC                0x10            /* ASYNC I/O, need signals */
 160 #define SB_UPCALL               0x20            /* someone wants an upcall */
 161 #define SB_NOINTR               0x40            /* operations not interruptible */
 162 #ifndef __APPLE__
 163 #define SB_AIO          0x80            /* AIO operations queued */
 164 #define SB_KNOTE                0x100   /* kernel note attached */
 165 #else
 166 #define SB_NOTIFY       (SB_WAIT|SB_SEL|SB_ASYNC)
 167 #define SB_RECV         0x8000          /* this is rcv sb */
 168
 169         caddr_t so_tpcb;                /* Wisc. protocol control block - XXX unused? */
 170 #endif
 171
 172         void    (*so_upcall) __P((struct socket *so, caddr_t arg, int waitf));
 173         caddr_t so_upcallarg;           /* Arg for above */
 174         uid_t   so_uid;                 /* who opened the socket */
 175         /* NB: generation count must not be first; easiest to make it last. */
 176         so_gen_t so_gencnt;             /* generation count */
 177 #ifndef __APPLE__
 178         void    *so_emuldata;           /* private data for emulators */
 179         struct  so_accf {
 180                 struct  accept_filter *so_accept_filter;
 181                 void    *so_accept_filter_arg;  /* saved filter args */
 182                 char    *so_accept_filter_str;  /* saved user args */
 183         } *so_accf;
 184 #else
 185         TAILQ_HEAD(,eventqelt) so_evlist;
 186         int     cached_in_sock_layer;   /* Is socket bundled with pcb/pcb.inp_ppcb? */
 187         struct  socket  *cache_next;
 188         struct  socket  *cache_prev;
 189         u_long          cache_timestamp;
 190         caddr_t         so_saved_pcb;   /* Saved pcb when cacheing */
 191         struct  mbuf *so_temp;          /* Holding area for outbound frags */
 192         /* Plug-in support - make the socket interface overridable */
 193         struct  mbuf *so_tail;
 194         struct  kextcb *so_ext;         /* NKE hook */
 195         u_long  so_flags;               /* Flags */
 196 #define SOF_NOSIGPIPE   0x00000001
 197         void    *reserved2;
 198         void    *reserved3;
 199         void    *reserved4;
 200 #endif
 201 };
 202 #endif /* __APPLE_API_UNSTABLE */
 203
 204 /*
 205  * Socket state bits.
 206  */
 207 #define SS_NOFDREF              0x001   /* no file table ref any more */
 208 #define SS_ISCONNECTED          0x002   /* socket connected to a peer */
 209 #define SS_ISCONNECTING         0x004   /* in process of connecting to peer */
 210 #define SS_ISDISCONNECTING      0x008   /* in process of disconnecting */
 211 #define SS_CANTSENDMORE         0x010   /* can't send more data to peer */
 212 #define SS_CANTRCVMORE          0x020   /* can't receive more data from peer */
 213 #define SS_RCVATMARK            0x040   /* at mark on input */
 214
 215 #define SS_PRIV                 0x080   /* privileged for broadcast, raw... */
 216 #define SS_NBIO                 0x100   /* non-blocking ops */
 217 #define SS_ASYNC                0x200   /* async i/o notify */
 218 #define SS_ISCONFIRMING         0x400   /* deciding to accept connection req */
 219 #define SS_INCOMP               0x800   /* Unaccepted, incomplete connection */
 220 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
 221 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
 222
 223 /*
 224  * Externalized form of struct socket used by the sysctl(3) interface.
 225  */
 226 struct  xsocket {
 227         size_t  xso_len;        /* length of this structure */
 228         struct  socket *xso_so; /* makes a convenient handle sometimes */
 229         short   so_type;
 230         short   so_options;
 231         short   so_linger;
 232         short   so_state;
 233         caddr_t so_pcb;         /* another convenient handle */
 234         int     xso_protocol;
 235         int     xso_family;
 236         short   so_qlen;
 237         short   so_incqlen;
 238         short   so_qlimit;
 239         short   so_timeo;
 240         u_short so_error;
 241         pid_t   so_pgid;
 242         u_long  so_oobmark;
 243         struct  xsockbuf {
 244                 u_long  sb_cc;
 245                 u_long  sb_hiwat;
 246                 u_long  sb_mbcnt;
 247                 u_long  sb_mbmax;
 248                 long    sb_lowat;
 249                 short   sb_flags;
 250                 short   sb_timeo;
 251         } so_rcv, so_snd;
 252         uid_t   so_uid;         /* XXX */
 253 };
 254
 255 /*
 256  * Macros for sockets and socket buffering.
 257  */
 258 #ifdef __APPLE__
 259 #ifdef __APPLE_API_UNSTABLE
 260 #define sbtoso(sb) (sb->sb_so)
 261
 262 /*
 263  * Functions for sockets and socket buffering.
 264  * These are macros on FreeBSD. On Darwin the
 265  * implementation is in bsd/kern/uipc_socket2.c
 266  */
 267 int             sb_notify __P((struct sockbuf *sb));
 268 long            sbspace __P((struct sockbuf *sb));
 269 int             sosendallatonce __P((struct socket *so));
 270 int             soreadable __P((struct socket *so));
 271 int             sowriteable __P((struct socket *so));
 272 void            sballoc __P((struct sockbuf *sb, struct mbuf *m));
 273 void            sbfree __P((struct sockbuf *sb, struct mbuf *m));
 274 int             sblock __P((struct sockbuf *sb, int wf));
 275 void            sbunlock __P((struct sockbuf *sb));
 276 void            sorwakeup __P((struct socket * so));
 277 void            sowwakeup __P((struct socket * so));
 278
 279 /*
 280  * Socket extension mechanism: control block hooks:
 281  * This is the "head" of any control block for an extenstion
 282  * Note: we separate intercept function dispatch vectors from
 283  *  the NFDescriptor to permit selective replacement during
 284  *  operation, e.g., to disable some functions.
 285  */
 286 struct kextcb
 287 {       struct kextcb *e_next;          /* Next kext control block */
 288         void *e_fcb;                    /* Real filter control block */
 289         struct NFDescriptor *e_nfd;     /* NKE Descriptor */
 290         /* Plug-in support - intercept functions */
 291         struct sockif *e_soif;          /* Socket functions */
 292         struct sockutil *e_sout;        /* Sockbuf utility functions */
 293 };
 294 #define EXT_NULL        0x0             /* STATE: Not in use */
 295 #define sotokextcb(so) (so ? so->so_ext : 0)
 296 #endif /* __APPLE___ */
 297
 298 #ifdef KERNEL
 299
 300 /*
 301  * Argument structure for sosetopt et seq.  This is in the KERNEL
 302  * section because it will never be visible to user code.
 303  */
 304 enum sopt_dir { SOPT_GET, SOPT_SET };
 305 struct sockopt {
 306         enum    sopt_dir sopt_dir; /* is this a get or a set? */
 307         int     sopt_level;     /* second arg of [gs]etsockopt */
 308         int     sopt_name;      /* third arg of [gs]etsockopt */
 309         void   *sopt_val;       /* fourth arg of [gs]etsockopt */
 310         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
 311         struct  proc *sopt_p;   /* calling process or null if kernel */
 312 };
 313
 314 #if SENDFILE
 315 struct sf_buf {
 316         SLIST_ENTRY(sf_buf) free_list;  /* list of free buffer slots */
 317         int             refcnt;         /* reference count */
 318         struct          vm_page *m;     /* currently mapped page */
 319         vm_offset_t     kva;            /* va of mapping */
 320 };
 321 #endif
 322
 323 #ifdef MALLOC_DECLARE
 324 MALLOC_DECLARE(M_PCB);
 325 MALLOC_DECLARE(M_SONAME);
 326 #endif
 327
 328 extern int      maxsockets;
 329 extern u_long   sb_max;
 330 extern int socket_zone;
 331 extern so_gen_t so_gencnt;
 332
 333 struct file;
 334 struct filedesc;
 335 struct mbuf;
 336 struct sockaddr;
 337 struct stat;
 338 struct ucred;
 339 struct uio;
 340 #ifndef __APPLE
 341 struct knote;
 342 #endif
 343
 344 /*
 345  * File operations on sockets.
 346  */
 347 int     soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred,
 348                 int flags, struct proc *p));
 349 int     soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred,
 350                 int flags, struct proc *p));
 351 int soo_close __P((struct file *fp, struct proc *p));
 352 int     soo_ioctl __P((struct file *fp, u_long cmd, caddr_t data,
 353             struct proc *p));
 354 int     soo_stat __P((struct socket *so, struct stat *ub));
 355 int     soo_select __P((struct file *fp, int which, void * wql, struct proc *p));
 356
 357 /*
 358  * From uipc_socket and friends
 359  */
 360 struct  sockaddr *dup_sockaddr __P((struct sockaddr *sa, int canwait));
 361 int     getsock __P((struct filedesc *fdp, int fd, struct file **fpp));
 362 int     sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type));
 363 int     getsockaddr __P((struct sockaddr **namp, caddr_t uaddr, size_t len));
 364 void    sbappend __P((struct sockbuf *sb, struct mbuf *m));
 365 int     sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa,
 366             struct mbuf *m0, struct mbuf *control));
 367 int     sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0,
 368             struct mbuf *control));
 369 void    sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0));
 370 void    sbcheck __P((struct sockbuf *sb));
 371 void    sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n));
 372 struct mbuf *
 373         sbcreatecontrol __P((caddr_t p, int size, int type, int level));
 374 void    sbdrop __P((struct sockbuf *sb, int len));
 375 void    sbdroprecord __P((struct sockbuf *sb));
 376 void    sbflush __P((struct sockbuf *sb));
 377 void    sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0));
 378 void    sbrelease __P((struct sockbuf *sb));
 379 int     sbreserve __P((struct sockbuf *sb, u_long cc));
 380 void    sbtoxsockbuf __P((struct sockbuf *sb, struct xsockbuf *xsb));
 381 int     sbwait __P((struct sockbuf *sb));
 382 int     sb_lock __P((struct sockbuf *sb));
 383 int     soabort __P((struct socket *so));
 384 int     soaccept __P((struct socket *so, struct sockaddr **nam));
 385 struct  socket *soalloc __P((int waitok, int dom, int type));
 386 int     sobind __P((struct socket *so, struct sockaddr *nam));
 387 void    socantrcvmore __P((struct socket *so));
 388 void    socantsendmore __P((struct socket *so));
 389 int     soclose __P((struct socket *so));
 390 int     soconnect __P((struct socket *so, struct sockaddr *nam));
 391 int     soconnect2 __P((struct socket *so1, struct socket *so2));
 392 int     socreate __P((int dom, struct socket **aso, int type, int proto));
 393 void    sodealloc __P((struct socket *so));
 394 int     sodisconnect __P((struct socket *so));
 395 void    sofree __P((struct socket *so));
 396 int     sogetopt __P((struct socket *so, struct sockopt *sopt));
 397 void    sohasoutofband __P((struct socket *so));
 398 void    soisconnected __P((struct socket *so));
 399 void    soisconnecting __P((struct socket *so));
 400 void    soisdisconnected __P((struct socket *so));
 401 void    soisdisconnecting __P((struct socket *so));
 402 int     solisten __P((struct socket *so, int backlog));
 403 struct socket *
 404         sodropablereq __P((struct socket *head));
 405 struct socket *
 406         sonewconn __P((struct socket *head, int connstatus));
 407 int     sooptcopyin __P((struct sockopt *sopt, void *buf, size_t len,
 408                          size_t minlen));
 409 int     sooptcopyout __P((struct sockopt *sopt, void *buf, size_t len));
 410
 411 /*
 412  * XXX; prepare mbuf for (__FreeBSD__ < 3) routines.
 413  * Used primarily in IPSec and IPv6 code.
 414  */
 415 int     soopt_getm __P((struct sockopt *sopt, struct mbuf **mp));
 416 int     soopt_mcopyin __P((struct sockopt *sopt, struct mbuf *m));
 417 int     soopt_mcopyout __P((struct sockopt *sopt, struct mbuf *m));
 418
 419 int     sopoll __P((struct socket *so, int events, struct ucred *cred, void *wql));
 420 int     soreceive __P((struct socket *so, struct sockaddr **paddr,
 421                        struct uio *uio, struct mbuf **mp0,
 422                        struct mbuf **controlp, int *flagsp));
 423 int     soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc));
 424 void    sorflush __P((struct socket *so));
 425 int     sosend __P((struct socket *so, struct sockaddr *addr, struct uio *uio,
 426                     struct mbuf *top, struct mbuf *control, int flags));
 427
 428 int     sosetopt __P((struct socket *so, struct sockopt *sopt));
 429 int     soshutdown __P((struct socket *so, int how));
 430 void    sotoxsocket __P((struct socket *so, struct xsocket *xso));
 431 void    sowakeup __P((struct socket *so, struct sockbuf *sb));
 432
 433 #ifndef __APPLE__
 434 /* accept filter functions */
 435 int     accept_filt_add __P((struct accept_filter *filt));
 436 int     accept_filt_del __P((char *name));
 437 struct accept_filter *  accept_filt_get __P((char *name));
 438 #ifdef ACCEPT_FILTER_MOD
 439 int accept_filt_generic_mod_event __P((module_t mod, int event, void *data));
 440 SYSCTL_DECL(_net_inet_accf);
 441 #endif /* ACCEPT_FILTER_MOD */
 442 #endif /* !defined(__APPLE__) */
 443
 444 #endif /* KERNEL */
 445 #endif /* __APPLE_API_UNSTABLE */
 446
 447 #endif /* !_SYS_SOCKETVAR_H_ */