sys/sys/socketvar.h

   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  * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.9 2002/08/14 22:23:10 dg 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  */
  49 typedef u_quad_t so_gen_t;
  50
  51 struct accept_filter;
  52
  53 struct socket {
  54         short   so_type;                /* generic type, see socket.h */
  55         short   so_options;             /* from socket call, see socket.h */
  56         short   so_linger;              /* time to linger while closing */
  57         short   so_state;               /* internal state flags SS_*, below */
  58         caddr_t so_pcb;                 /* protocol control block */
  59         struct  protosw *so_proto;      /* protocol handle */
  60 /*
  61  * Variables for connection queuing.
  62  * Socket where accepts occur is so_head in all subsidiary sockets.
  63  * If so_head is 0, socket is not related to an accept.
  64  * For head socket so_incomp queues partially completed connections,
  65  * while so_comp is a queue of connections ready to be accepted.
  66  * If a connection is aborted and it has so_head set, then
  67  * it has to be pulled out of either so_incomp or so_comp.
  68  * We allow connections to queue up based on current queue lengths
  69  * and limit on number of queued connections for this socket.
  70  */
  71         struct  socket *so_head;        /* back pointer to accept socket */
  72         TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */
  73         TAILQ_HEAD(, socket) so_comp;   /* queue of complete unaccepted connections */
  74         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
  75         short   so_qlen;                /* number of unaccepted connections */
  76         short   so_incqlen;             /* number of unaccepted incomplete
  77                                            connections */
  78         short   so_qlimit;              /* max number queued connections */
  79         short   so_timeo;               /* connection timeout */
  80         u_short so_error;               /* error affecting connection */
  81         struct  sigio *so_sigio;        /* information for async I/O or
  82                                            out of band data (SIGURG) */
  83         u_long  so_oobmark;             /* chars to oob mark */
  84         TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
  85 /*
  86  * Variables for socket buffering.
  87  */
  88         struct  sockbuf {
  89                 u_long  sb_cc;          /* actual chars in buffer */
  90                 u_long  sb_hiwat;       /* max actual char count */
  91                 u_long  sb_mbcnt;       /* chars of mbufs used */
  92                 u_long  sb_mbmax;       /* max chars of mbufs to use */
  93                 long    sb_lowat;       /* low water mark */
  94                 struct  mbuf *sb_mb;    /* the mbuf chain */
  95                 struct  selinfo sb_sel; /* process selecting read/write */
  96                 short   sb_flags;       /* flags, see below */
  97                 short   sb_timeo;       /* timeout for read/write */
  98         } so_rcv, so_snd;
  99 #define SB_MAX          (256*1024)      /* default for max chars in sockbuf */
 100 #define SB_LOCK         0x01            /* lock on data queue */
 101 #define SB_WANT         0x02            /* someone is waiting to lock */
 102 #define SB_WAIT         0x04            /* someone is waiting for data/space */
 103 #define SB_SEL          0x08            /* someone is selecting */
 104 #define SB_ASYNC        0x10            /* ASYNC I/O, need signals */
 105 #define SB_UPCALL       0x20            /* someone wants an upcall */
 106 #define SB_NOINTR       0x40            /* operations not interruptible */
 107 #define SB_AIO          0x80            /* AIO operations queued */
 108 #define SB_KNOTE        0x100           /* kernel note attached */
 109
 110         void    (*so_upcall) __P((struct socket *, void *, int));
 111         void    *so_upcallarg;
 112         struct  ucred *so_cred;         /* user credentials */
 113         /* NB: generation count must not be first; easiest to make it last. */
 114         so_gen_t so_gencnt;             /* generation count */
 115         void    *so_emuldata;           /* private data for emulators */
 116         struct  so_accf {
 117                 struct  accept_filter *so_accept_filter;
 118                 void    *so_accept_filter_arg;  /* saved filter args */
 119                 char    *so_accept_filter_str;  /* saved user args */
 120         } *so_accf;
 121 };
 122
 123 /*
 124  * Socket state bits.
 125  */
 126 #define SS_NOFDREF              0x0001  /* no file table ref any more */
 127 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
 128 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
 129 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
 130 #define SS_CANTSENDMORE         0x0010  /* can't send more data to peer */
 131 #define SS_CANTRCVMORE          0x0020  /* can't receive more data from peer */
 132 #define SS_RCVATMARK            0x0040  /* at mark on input */
 133
 134 #define SS_NBIO                 0x0100  /* non-blocking ops */
 135 #define SS_ASYNC                0x0200  /* async i/o notify */
 136 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
 137
 138 #define SS_INCOMP               0x0800  /* unaccepted, incomplete connection */
 139 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
 140 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
 141
 142 /*
 143  * Externalized form of struct socket used by the sysctl(3) interface.
 144  */
 145 struct  xsocket {
 146         size_t  xso_len;        /* length of this structure */
 147         struct  socket *xso_so; /* makes a convenient handle sometimes */
 148         short   so_type;
 149         short   so_options;
 150         short   so_linger;
 151         short   so_state;
 152         caddr_t so_pcb;         /* another convenient handle */
 153         int     xso_protocol;
 154         int     xso_family;
 155         short   so_qlen;
 156         short   so_incqlen;
 157         short   so_qlimit;
 158         short   so_timeo;
 159         u_short so_error;
 160         pid_t   so_pgid;
 161         u_long  so_oobmark;
 162         struct  xsockbuf {
 163                 u_long  sb_cc;
 164                 u_long  sb_hiwat;
 165                 u_long  sb_mbcnt;
 166                 u_long  sb_mbmax;
 167                 long    sb_lowat;
 168                 short   sb_flags;
 169                 short   sb_timeo;
 170         } so_rcv, so_snd;
 171         uid_t   so_uid;         /* XXX */
 172 };
 173
 174 /*
 175  * Macros for sockets and socket buffering.
 176  */
 177
 178 /*
 179  * Do we need to notify the other side when I/O is possible?
 180  */
 181 #define sb_notify(sb)   (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \
 182     SB_UPCALL | SB_AIO | SB_KNOTE)) != 0)
 183
 184 /*
 185  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
 186  * This is problematical if the fields are unsigned, as the space might
 187  * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
 188  * overflow and return 0.  Should use "lmin" but it doesn't exist now.
 189  */
 190 #define sbspace(sb) \
 191     ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \
 192          (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))
 193
 194 /* do we have to send all at once on a socket? */
 195 #define sosendallatonce(so) \
 196     ((so)->so_proto->pr_flags & PR_ATOMIC)
 197
 198 /* can we read something from so? */
 199 #define soreadable(so) \
 200     ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \
 201         ((so)->so_state & SS_CANTRCVMORE) || \
 202         (so)->so_comp.tqh_first || (so)->so_error)
 203
 204 /* can we write something to so? */
 205 #define sowriteable(so) \
 206     ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \
 207         (((so)->so_state&SS_ISCONNECTED) || \
 208           ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
 209      ((so)->so_state & SS_CANTSENDMORE) || \
 210      (so)->so_error)
 211
 212 /* adjust counters in sb reflecting allocation of m */
 213 #define sballoc(sb, m) { \
 214         (sb)->sb_cc += (m)->m_len; \
 215         (sb)->sb_mbcnt += MSIZE; \
 216         if ((m)->m_flags & M_EXT) \
 217                 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \
 218 }
 219
 220 /* adjust counters in sb reflecting freeing of m */
 221 #define sbfree(sb, m) { \
 222         (sb)->sb_cc -= (m)->m_len; \
 223         (sb)->sb_mbcnt -= MSIZE; \
 224         if ((m)->m_flags & M_EXT) \
 225                 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
 226 }
 227
 228 /*
 229  * Set lock on sockbuf sb; sleep if lock is already held.
 230  * Unless SB_NOINTR is set on sockbuf, sleep is interruptible.
 231  * Returns error without lock if sleep is interrupted.
 232  */
 233 #define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \
 234                 (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \
 235                 ((sb)->sb_flags |= SB_LOCK), 0)
 236
 237 /* release lock on sockbuf sb */
 238 #define sbunlock(sb) { \
 239         (sb)->sb_flags &= ~SB_LOCK; \
 240         if ((sb)->sb_flags & SB_WANT) { \
 241                 (sb)->sb_flags &= ~SB_WANT; \
 242                 wakeup((caddr_t)&(sb)->sb_flags); \
 243         } \
 244 }
 245
 246 #define sorwakeup(so)   do { \
 247                           if (sb_notify(&(so)->so_rcv)) \
 248                             sowakeup((so), &(so)->so_rcv); \
 249                         } while (0)
 250
 251 #define sowwakeup(so)   do { \
 252                           if (sb_notify(&(so)->so_snd)) \
 253                             sowakeup((so), &(so)->so_snd); \
 254                         } while (0)
 255
 256 #ifdef _KERNEL
 257
 258 /*
 259  * Argument structure for sosetopt et seq.  This is in the KERNEL
 260  * section because it will never be visible to user code.
 261  */
 262 enum sopt_dir { SOPT_GET, SOPT_SET };
 263 struct sockopt {
 264         enum    sopt_dir sopt_dir; /* is this a get or a set? */
 265         int     sopt_level;     /* second arg of [gs]etsockopt */
 266         int     sopt_name;      /* third arg of [gs]etsockopt */
 267         void   *sopt_val;       /* fourth arg of [gs]etsockopt */
 268         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
 269         struct  proc *sopt_p;   /* calling process or null if kernel */
 270 };
 271
 272 struct sf_buf {
 273         SLIST_ENTRY(sf_buf) free_list;  /* list of free buffer slots */
 274         int             refcnt;         /* reference count */
 275         struct          vm_page *m;     /* currently mapped page */
 276         vm_offset_t     kva;            /* va of mapping */
 277 };
 278
 279 struct accept_filter {
 280         char    accf_name[16];
 281         void    (*accf_callback)
 282                 __P((struct socket *so, void *arg, int waitflag));
 283         void *  (*accf_create)
 284                 __P((struct socket *so, char *arg));
 285         void    (*accf_destroy)
 286                 __P((struct socket *so));
 287         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
 288 };
 289
 290 #ifdef MALLOC_DECLARE
 291 MALLOC_DECLARE(M_PCB);
 292 MALLOC_DECLARE(M_SONAME);
 293 MALLOC_DECLARE(M_ACCF);
 294 #endif
 295
 296 extern int      maxsockets;
 297 extern u_long   sb_max;
 298 extern struct   vm_zone *socket_zone;
 299 extern so_gen_t so_gencnt;
 300
 301 struct file;
 302 struct filedesc;
 303 struct mbuf;
 304 struct sockaddr;
 305 struct stat;
 306 struct ucred;
 307 struct uio;
 308 struct knote;
 309
 310 /*
 311  * File operations on sockets.
 312  */
 313 int     soo_read __P((struct file *fp, struct uio *uio, struct ucred *cred,
 314             int flags, struct proc *p));
 315 int     soo_write __P((struct file *fp, struct uio *uio, struct ucred *cred,
 316             int flags, struct proc *p));
 317 int     soo_close __P((struct file *fp, struct proc *p));
 318 int     soo_ioctl __P((struct file *fp, u_long cmd, caddr_t data,
 319             struct proc *p));
 320 int     soo_poll __P((struct file *fp, int events, struct ucred *cred,
 321             struct proc *p));
 322 int     soo_stat __P((struct file *fp, struct stat *ub, struct proc *p));
 323 int     sokqfilter __P((struct file *fp, struct knote *kn));
 324
 325 /*
 326  * From uipc_socket and friends
 327  */
 328 struct  sockaddr *dup_sockaddr __P((struct sockaddr *sa, int canwait));
 329 int     holdsock __P((struct filedesc *fdp, int fdes, struct file **fpp));
 330 int     sockargs __P((struct mbuf **mp, caddr_t buf, int buflen, int type));
 331 int     getsockaddr __P((struct sockaddr **namp, caddr_t uaddr, size_t len));
 332 void    sbappend __P((struct sockbuf *sb, struct mbuf *m));
 333 int     sbappendaddr __P((struct sockbuf *sb, struct sockaddr *asa,
 334             struct mbuf *m0, struct mbuf *control));
 335 int     sbappendcontrol __P((struct sockbuf *sb, struct mbuf *m0,
 336             struct mbuf *control));
 337 void    sbappendrecord __P((struct sockbuf *sb, struct mbuf *m0));
 338 void    sbcheck __P((struct sockbuf *sb));
 339 void    sbcompress __P((struct sockbuf *sb, struct mbuf *m, struct mbuf *n));
 340 struct mbuf *
 341         sbcreatecontrol __P((caddr_t p, int size, int type, int level));
 342 void    sbdrop __P((struct sockbuf *sb, int len));
 343 void    sbdroprecord __P((struct sockbuf *sb));
 344 void    sbflush __P((struct sockbuf *sb));
 345 void    sbinsertoob __P((struct sockbuf *sb, struct mbuf *m0));
 346 void    sbrelease __P((struct sockbuf *sb, struct socket *so));
 347 int     sbreserve __P((struct sockbuf *sb, u_long cc, struct socket *so,
 348                        struct proc *p));
 349 void    sbtoxsockbuf __P((struct sockbuf *sb, struct xsockbuf *xsb));
 350 int     sbwait __P((struct sockbuf *sb));
 351 int     sb_lock __P((struct sockbuf *sb));
 352 struct sf_buf *
 353         sf_buf_alloc(void);
 354 void    sf_buf_free(caddr_t addr, u_int size);
 355 void    sf_buf_ref(caddr_t addr, u_int size);
 356 int     soabort __P((struct socket *so));
 357 int     soaccept __P((struct socket *so, struct sockaddr **nam));
 358 struct  socket *soalloc __P((int waitok));
 359 int     sobind __P((struct socket *so, struct sockaddr *nam, struct proc *p));
 360 void    socantrcvmore __P((struct socket *so));
 361 void    socantsendmore __P((struct socket *so));
 362 int     soclose __P((struct socket *so));
 363 int     soconnect __P((struct socket *so, struct sockaddr *nam, struct proc *p));
 364 int     soconnect2 __P((struct socket *so1, struct socket *so2));
 365 int     socreate __P((int dom, struct socket **aso, int type, int proto,
 366             struct proc *p));
 367 void    sodealloc __P((struct socket *so));
 368 int     sodisconnect __P((struct socket *so));
 369 void    sofree __P((struct socket *so));
 370 int     sogetopt __P((struct socket *so, struct sockopt *sopt));
 371 void    sohasoutofband __P((struct socket *so));
 372 void    soisconnected __P((struct socket *so));
 373 void    soisconnecting __P((struct socket *so));
 374 void    soisdisconnected __P((struct socket *so));
 375 void    soisdisconnecting __P((struct socket *so));
 376 int     solisten __P((struct socket *so, int backlog, struct proc *p));
 377 struct socket *
 378         sonewconn __P((struct socket *head, int connstatus));
 379 struct socket *
 380         sonewconn3 __P((struct socket *head, int connstatus, struct proc *p));
 381 int     sooptcopyin __P((struct sockopt *sopt, void *buf, size_t len,
 382                          size_t minlen));
 383 int     sooptcopyout __P((struct sockopt *sopt, void *buf, size_t len));
 384
 385 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
 386 int     soopt_getm __P((struct sockopt *sopt, struct mbuf **mp));
 387 int     soopt_mcopyin __P((struct sockopt *sopt, struct mbuf *m));
 388 int     soopt_mcopyout __P((struct sockopt *sopt, struct mbuf *m));
 389
 390 int     sopoll __P((struct socket *so, int events, struct ucred *cred,
 391                     struct proc *p));
 392 int     soreceive __P((struct socket *so, struct sockaddr **paddr,
 393                        struct uio *uio, struct mbuf **mp0,
 394                        struct mbuf **controlp, int *flagsp));
 395 int     soreserve __P((struct socket *so, u_long sndcc, u_long rcvcc));
 396 void    sorflush __P((struct socket *so));
 397 int     sosend __P((struct socket *so, struct sockaddr *addr, struct uio *uio,
 398                     struct mbuf *top, struct mbuf *control, int flags,
 399                     struct proc *p));
 400 int     sosetopt __P((struct socket *so, struct sockopt *sopt));
 401 int     soshutdown __P((struct socket *so, int how));
 402 void    sotoxsocket __P((struct socket *so, struct xsocket *xso));
 403 void    sowakeup __P((struct socket *so, struct sockbuf *sb));
 404
 405 /* accept filter functions */
 406 int     accept_filt_add __P((struct accept_filter *filt));
 407 int     accept_filt_del __P((char *name));
 408 struct accept_filter *  accept_filt_get __P((char *name));
 409 #ifdef ACCEPT_FILTER_MOD
 410 int accept_filt_generic_mod_event __P((module_t mod, int event, void *data));
 411 SYSCTL_DECL(_net_inet_accf);
 412 #endif /* ACCEPT_FILTER_MOD */
 413
 414 #endif /* _KERNEL */
 415
 416 #endif /* !_SYS_SOCKETVAR_H_ */