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.10 2003/08/24 08:24:39 hsu Exp $
  35  * $DragonFly: src/sys/sys/socketvar.h,v 1.34 2008/08/15 17:37:29 nth Exp $
  36  */
  37
  38 #ifndef _SYS_SOCKETVAR_H_
  39 #define _SYS_SOCKETVAR_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #ifndef _SYS_QUEUE_H_
  45 #include <sys/queue.h>                  /* for TAILQ macros */
  46 #endif
  47 #ifndef _SYS_SELINFO_H_
  48 #include <sys/selinfo.h>                /* for struct selinfo */
  49 #endif
  50 #ifndef _SYS_SOCKBUF_H_
  51 #include <sys/sockbuf.h>
  52 #endif
  53
  54 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  55
  56 struct accept_filter;
  57
  58 /*
  59  * Signaling socket buffers contain additional elements for locking
  60  * and signaling conditions.  These are used primarily by sockets.
  61  */
  62 struct signalsockbuf {
  63         struct sockbuf sb;
  64         struct selinfo ssb_sel; /* process selecting read/write */
  65         short   ssb_flags;      /* flags, see below */
  66         short   ssb_timeo;      /* timeout for read/write */
  67         long    ssb_lowat;      /* low water mark */
  68         u_long  ssb_hiwat;      /* high water mark / max actual char count */
  69         u_long  ssb_mbmax;      /* max chars of mbufs to use */
  70 };
  71
  72 #define ssb_cc          sb.sb_cc        /* commonly used fields */
  73 #define ssb_mb          sb.sb_mb        /* commonly used fields */
  74 #define ssb_mbcnt       sb.sb_mbcnt     /* commonly used fields */
  75
  76 #define SSB_LOCK        0x01            /* lock on data queue */
  77 #define SSB_WANT        0x02            /* someone is waiting to lock */
  78 #define SSB_WAIT        0x04            /* someone is waiting for data/space */
  79 #define SSB_SEL         0x08            /* someone is selecting */
  80 #define SSB_ASYNC       0x10            /* ASYNC I/O, need signals */
  81 #define SSB_UPCALL      0x20            /* someone wants an upcall */
  82 #define SSB_NOINTR      0x40            /* operations not interruptible */
  83 #define SSB_AIO         0x80            /* AIO operations queued */
  84 #define SSB_KNOTE       0x100           /* kernel note attached */
  85 #define SSB_MEVENT      0x200           /* need message event notification */
  86 #define SSB_STOP        0x400           /* backpressure indicator */
  87
  88 /*
  89  * Per-socket kernel structure.  Contains universal send and receive queues,
  90  * protocol control handle, and error information.
  91  */
  92 struct socket {
  93         short   so_type;                /* generic type, see socket.h */
  94         short   so_options;             /* from socket call, see socket.h */
  95         short   so_linger;              /* time to linger while closing */
  96         short   so_state;               /* internal state flags SS_*, below */
  97         void    *so_pcb;                /* protocol control block */
  98         struct  protosw *so_proto;      /* protocol handle */
  99         struct  socket *so_head;        /* back pointer to accept socket */
 100
 101         /*
 102          * These fields are used to manage sockets capable of accepting
 103          * new connections.
 104          */
 105         TAILQ_HEAD(, socket) so_incomp; /* in-progress, incomplete */
 106         TAILQ_HEAD(, socket) so_comp;   /* completed but not yet accepted */
 107         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
 108         short   so_qlen;                /* so_comp count */
 109         short   so_incqlen;             /* so_incomp count */
 110         short   so_qlimit;              /* max number queued connections */
 111
 112         /*
 113          * Misc socket support
 114          */
 115         short   so_timeo;               /* connection timeout */
 116         u_short so_error;               /* error affecting connection */
 117         struct  sigio *so_sigio;        /* information for async I/O or
 118                                            out of band data (SIGURG) */
 119         u_long  so_oobmark;             /* chars to oob mark */
 120         TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
 121         struct signalsockbuf so_rcv;
 122         struct signalsockbuf so_snd;
 123
 124         void    (*so_upcall) (struct socket *, void *, int);
 125         void    *so_upcallarg;
 126         struct  ucred *so_cred;         /* user credentials */
 127         /* NB: generation count must not be first; easiest to make it last. */
 128         void    *so_emuldata;           /* private data for emulators */
 129         struct  so_accf {
 130                 struct  accept_filter *so_accept_filter;
 131                 void    *so_accept_filter_arg;  /* saved filter args */
 132                 char    *so_accept_filter_str;  /* saved user args */
 133         } *so_accf;
 134 };
 135
 136 #endif
 137
 138 /*
 139  * Socket state bits.
 140  */
 141 #define SS_NOFDREF              0x0001  /* no file table ref any more */
 142 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
 143 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
 144 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
 145 #define SS_CANTSENDMORE         0x0010  /* can't send more data to peer */
 146 #define SS_CANTRCVMORE          0x0020  /* can't receive more data from peer */
 147 #define SS_RCVATMARK            0x0040  /* at mark on input */
 148
 149 #define SS_UNUSED0100           0x0100
 150 #define SS_ASYNC                0x0200  /* async i/o notify */
 151 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
 152
 153 #define SS_INCOMP               0x0800  /* unaccepted, incomplete connection */
 154 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
 155 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
 156
 157 /*
 158  * Externalized form of struct socket used by the sysctl(3) interface.
 159  */
 160 struct  xsocket {
 161         size_t  xso_len;        /* length of this structure */
 162         struct  socket *xso_so; /* makes a convenient handle sometimes */
 163         short   so_type;
 164         short   so_options;
 165         short   so_linger;
 166         short   so_state;
 167         void    *so_pcb;                /* another convenient handle */
 168         int     xso_protocol;
 169         int     xso_family;
 170         short   so_qlen;
 171         short   so_incqlen;
 172         short   so_qlimit;
 173         short   so_timeo;
 174         u_short so_error;
 175         pid_t   so_pgid;
 176         u_long  so_oobmark;
 177         struct  xsockbuf {
 178                 u_long  sb_cc;
 179                 u_long  sb_hiwat;
 180                 u_long  sb_mbcnt;
 181                 u_long  sb_mbmax;
 182                 long    sb_lowat;
 183                 short   sb_flags;
 184                 short   sb_timeo;
 185         } so_rcv, so_snd;
 186         uid_t   so_uid;         /* XXX */
 187 };
 188
 189 /*
 190  * Macros for sockets and socket buffering.
 191  */
 192
 193 #define sosendallatonce(so) \
 194     ((so)->so_proto->pr_flags & PR_ATOMIC)
 195
 196 /* can we read something from so? */
 197 #define soreadable(so) \
 198     ((so)->so_rcv.ssb_cc >= (so)->so_rcv.ssb_lowat || \
 199         ((so)->so_state & SS_CANTRCVMORE) || \
 200         !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
 201
 202 /* can we write something to so? */
 203 #define sowriteable(so) \
 204     ((ssb_space(&(so)->so_snd) >= (so)->so_snd.ssb_lowat && \
 205         (((so)->so_state&SS_ISCONNECTED) || \
 206           ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
 207      ((so)->so_state & SS_CANTSENDMORE) || \
 208      (so)->so_error)
 209
 210 /*
 211  * Do we need to notify the other side when I/O is possible?
 212  */
 213 #define ssb_notify(ssb)                                 \
 214         (((ssb)->ssb_flags &                            \
 215         (SSB_WAIT | SSB_SEL | SSB_ASYNC | SSB_UPCALL |  \
 216         SSB_AIO | SSB_KNOTE | SSB_MEVENT)))
 217
 218 /* do we have to send all at once on a socket? */
 219
 220 #ifdef _KERNEL
 221
 222 /*
 223  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
 224  * This is problematical if the fields are unsigned, as the space might
 225  * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
 226  * overflow and return 0.
 227  *
 228  * SSB_STOP ignores cc/hiwat and returns 0.  This is used by unix domain
 229  * stream sockets to signal backpressure.
 230  */
 231 static __inline
 232 long
 233 ssb_space(struct signalsockbuf *ssb)
 234 {
 235         long bleft;
 236         long mleft;
 237
 238         if (ssb->ssb_flags & SSB_STOP)
 239                 return(0);
 240         bleft = ssb->ssb_hiwat - ssb->ssb_cc;
 241         mleft = ssb->ssb_mbmax - ssb->ssb_mbcnt;
 242         return((bleft < mleft) ? bleft : mleft);
 243 }
 244
 245 #endif
 246
 247 #define ssb_append(ssb, m)                                              \
 248         sbappend(&(ssb)->sb, m)
 249
 250 #define ssb_appendstream(ssb, m)                                        \
 251         sbappendstream(&(ssb)->sb, m)
 252
 253 #define ssb_appendrecord(ssb, m)                                        \
 254         sbappendrecord(&(ssb)->sb, m)
 255
 256 #define ssb_appendaddr(ssb, src, m, control)                            \
 257         ((ssb_space(ssb) <= 0) ? 0 : sbappendaddr(&(ssb)->sb, src, m, control))
 258
 259 #define ssb_appendcontrol(ssb, m, control)                              \
 260         ((ssb_space(ssb) <= 0) ? 0 : sbappendcontrol(&(ssb)->sb, m, control))
 261
 262 #define ssb_insert_knote(ssb, kn) {                                     \
 263         SLIST_INSERT_HEAD(&(ssb)->ssb_sel.si_note, kn, kn_selnext);     \
 264         (ssb)->ssb_flags |= SSB_KNOTE;                                  \
 265 }
 266
 267 #define ssb_remove_knote(ssb, kn) {                                     \
 268         SLIST_REMOVE(&(ssb)->ssb_sel.si_note, kn, knote, kn_selnext);   \
 269         if (SLIST_EMPTY(&(ssb)->ssb_sel.si_note))                       \
 270                 (ssb)->ssb_flags &= ~SSB_KNOTE;                         \
 271 }
 272
 273 #define sorwakeup(so)   do { \
 274                           if (ssb_notify(&(so)->so_rcv)) \
 275                             sowakeup((so), &(so)->so_rcv); \
 276                         } while (0)
 277
 278 #define sowwakeup(so)   do { \
 279                           if (ssb_notify(&(so)->so_snd)) \
 280                             sowakeup((so), &(so)->so_snd); \
 281                         } while (0)
 282
 283 #ifdef _KERNEL
 284
 285 /*
 286  * Argument structure for sosetopt et seq.  This is in the KERNEL
 287  * section because it will never be visible to user code.
 288  */
 289 enum sopt_dir { SOPT_GET, SOPT_SET };
 290 struct sockopt {
 291         enum    sopt_dir sopt_dir; /* is this a get or a set? */
 292         int     sopt_level;     /* second arg of [gs]etsockopt */
 293         int     sopt_name;      /* third arg of [gs]etsockopt */
 294         void   *sopt_val;       /* fourth arg of [gs]etsockopt */
 295         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
 296         struct  thread *sopt_td; /* calling thread or null if kernel */
 297 };
 298
 299 struct accept_filter {
 300         char    accf_name[16];
 301         void    (*accf_callback)
 302                 (struct socket *so, void *arg, int waitflag);
 303         void *  (*accf_create)
 304                 (struct socket *so, char *arg);
 305         void    (*accf_destroy)
 306                 (struct socket *so);
 307         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
 308 };
 309
 310 #ifdef MALLOC_DECLARE
 311 MALLOC_DECLARE(M_PCB);
 312 MALLOC_DECLARE(M_SONAME);
 313 MALLOC_DECLARE(M_ACCF);
 314 #endif
 315
 316 extern int      maxsockets;
 317 extern u_long   sb_max;         /* nominal limit */
 318 extern u_long   sb_max_adj;     /* actual limit used by sbreserve() */
 319
 320 struct file;
 321 struct filedesc;
 322 struct mbuf;
 323 struct rlimit;
 324 struct sockaddr;
 325 struct stat;
 326 struct ucred;
 327 struct uio;
 328 struct knote;
 329
 330 /*
 331  * File operations on sockets.
 332  */
 333 int     soo_read (struct file *fp, struct uio *uio, struct ucred *cred,
 334             int flags);
 335 int     soo_write (struct file *fp, struct uio *uio, struct ucred *cred,
 336             int flags);
 337 int     soo_close (struct file *fp);
 338 int     soo_shutdown (struct file *fp, int how);
 339 int     soo_ioctl (struct file *fp, u_long cmd, caddr_t data,
 340             struct ucred *cred);
 341 int     soo_poll (struct file *fp, int events, struct ucred *cred);
 342 int     soo_stat (struct file *fp, struct stat *ub, struct ucred *cred);
 343 int     sokqfilter (struct file *fp, struct knote *kn);
 344
 345 /*
 346  * From uipc_socket and friends
 347  */
 348 struct  sockaddr *dup_sockaddr (const struct sockaddr *sa);
 349 int     getsockaddr (struct sockaddr **namp, caddr_t uaddr, size_t len);
 350
 351 void    ssb_release (struct signalsockbuf *ssb, struct socket *so);
 352 int     ssb_reserve (struct signalsockbuf *ssb, u_long cc, struct socket *so,
 353                    struct rlimit *rl);
 354 void    ssbtoxsockbuf (struct signalsockbuf *sb, struct xsockbuf *xsb);
 355 int     ssb_wait (struct signalsockbuf *sb);
 356 int     _ssb_lock (struct signalsockbuf *sb);
 357
 358 int     soabort (struct socket *so);
 359 int     soaccept (struct socket *so, struct sockaddr **nam);
 360 struct  socket *soalloc (int waitok);
 361 int     sobind (struct socket *so, struct sockaddr *nam, struct thread *td);
 362 void    socantrcvmore (struct socket *so);
 363 void    socantsendmore (struct socket *so);
 364 int     soclose (struct socket *so, int fflags);
 365 int     soconnect (struct socket *so, struct sockaddr *nam, struct thread *td);
 366 int     soconnect2 (struct socket *so1, struct socket *so2);
 367 int     socreate (int dom, struct socket **aso, int type, int proto,
 368             struct thread *td);
 369 void    sodealloc (struct socket *so);
 370 int     sodisconnect (struct socket *so);
 371 void    sofree (struct socket *so);
 372 int     sogetopt (struct socket *so, struct sockopt *sopt);
 373 void    sohasoutofband (struct socket *so);
 374 void    soisconnected (struct socket *so);
 375 void    soisconnecting (struct socket *so);
 376 void    soisdisconnected (struct socket *so);
 377 void    soisdisconnecting (struct socket *so);
 378 int     solisten (struct socket *so, int backlog, struct thread *td);
 379 struct socket *sonewconn (struct socket *head, int connstatus);
 380 int     sooptcopyin (struct sockopt *sopt, void *buf, size_t len,
 381                          size_t minlen);
 382 int     soopt_to_kbuf (struct sockopt *sopt, void *buf, size_t len,
 383                          size_t minlen);
 384 int     sooptcopyout (struct sockopt *sopt, const void *buf, size_t len);
 385 void    soopt_from_kbuf (struct sockopt *sopt, const void *buf, size_t len);
 386
 387 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
 388 int     soopt_getm (struct sockopt *sopt, struct mbuf **mp);
 389 int     soopt_mcopyin (struct sockopt *sopt, struct mbuf *m);
 390 void    soopt_to_mbuf (struct sockopt *sopt, struct mbuf *m);
 391 int     soopt_mcopyout (struct sockopt *sopt, struct mbuf *m);
 392 int     soopt_from_mbuf (struct sockopt *sopt, struct mbuf *m);
 393
 394 int     sopoll (struct socket *so, int events, struct ucred *cred,
 395                     struct thread *td);
 396 int     soreceive (struct socket *so, struct sockaddr **paddr,
 397                        struct uio *uio, struct sockbuf *sio,
 398                        struct mbuf **controlp, int *flagsp);
 399 int     soreserve (struct socket *so, u_long sndcc, u_long rcvcc,
 400                    struct rlimit *rl);
 401 void    sorflush (struct socket *so);
 402 int     sosend (struct socket *so, struct sockaddr *addr, struct uio *uio,
 403                     struct mbuf *top, struct mbuf *control, int flags,
 404                     struct thread *td);
 405 int     sosendudp (struct socket *so, struct sockaddr *addr, struct uio *uio,
 406                     struct mbuf *top, struct mbuf *control, int flags,
 407                     struct thread *td);
 408 int     sosetopt (struct socket *so, struct sockopt *sopt);
 409 int     soshutdown (struct socket *so, int how);
 410 void    sotoxsocket (struct socket *so, struct xsocket *xso);
 411 void    sowakeup (struct socket *so, struct signalsockbuf *sb);
 412
 413 /* accept filter functions */
 414 int     accept_filt_add (struct accept_filter *filt);
 415 int     accept_filt_del (char *name);
 416 struct accept_filter *  accept_filt_get (char *name);
 417 #ifdef ACCEPT_FILTER_MOD
 418 int accept_filt_generic_mod_event (module_t mod, int event, void *data);
 419 SYSCTL_DECL(_net_inet_accf);
 420 #endif /* ACCEPT_FILTER_MOD */
 421
 422 #endif /* _KERNEL */
 423
 424 #endif /* !_SYS_SOCKETVAR_H_ */