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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)socketvar.h 8.3 (Berkeley) 2/19/95
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _SYS_SOCKETVAR_H_
  35 #define _SYS_SOCKETVAR_H_
  36
  37 #include <sys/queue.h>                  /* for TAILQ macros */
  38 #include <sys/selinfo.h>                /* for struct selinfo */
  39 #include <sys/_lock.h>
  40 #include <sys/_mutex.h>
  41 #include <sys/osd.h>
  42 #include <sys/_sx.h>
  43 #include <sys/sockbuf.h>
  44 #include <sys/sockstate.h>
  45 #ifdef _KERNEL
  46 #include <sys/caprights.h>
  47 #include <sys/sockopt.h>
  48 #endif
  49
  50 struct vnet;
  51
  52 /*
  53  * Kernel structure per socket.
  54  * Contains send and receive buffer queues,
  55  * handle on protocol and pointer to protocol
  56  * private data and error information.
  57  */
  58 typedef u_quad_t so_gen_t;
  59
  60 struct socket;
  61
  62 /*-
  63  * Locking key to struct socket:
  64  * (a) constant after allocation, no locking required.
  65  * (b) locked by SOCK_LOCK(so).
  66  * (c) locked by SOCKBUF_LOCK(&so->so_rcv).
  67  * (e) locked by ACCEPT_LOCK().
  68  * (f) not locked since integer reads/writes are atomic.
  69  * (g) used only as a sleep/wakeup address, no value.
  70  * (h) locked by global mutex so_global_mtx.
  71  */
  72 struct socket {
  73         int     so_count;               /* (b) reference count */
  74         short   so_type;                /* (a) generic type, see socket.h */
  75         short   so_options;             /* from socket call, see socket.h */
  76         short   so_linger;              /* time to linger while closing */
  77         short   so_state;               /* (b) internal state flags SS_* */
  78         int     so_qstate;              /* (e) internal state flags SQ_* */
  79         void    *so_pcb;                /* protocol control block */
  80         struct  vnet *so_vnet;          /* (a) network stack instance */
  81         struct  protosw *so_proto;      /* (a) protocol handle */
  82 /*
  83  * Variables for connection queuing.
  84  * Socket where accepts occur is so_head in all subsidiary sockets.
  85  * If so_head is 0, socket is not related to an accept.
  86  * For head socket so_incomp queues partially completed connections,
  87  * while so_comp is a queue of connections ready to be accepted.
  88  * If a connection is aborted and it has so_head set, then
  89  * it has to be pulled out of either so_incomp or so_comp.
  90  * We allow connections to queue up based on current queue lengths
  91  * and limit on number of queued connections for this socket.
  92  */
  93         struct  socket *so_head;        /* (e) back pointer to listen socket */
  94         TAILQ_HEAD(, socket) so_incomp; /* (e) queue of partial unaccepted connections */
  95         TAILQ_HEAD(, socket) so_comp;   /* (e) queue of complete unaccepted connections */
  96         TAILQ_ENTRY(socket) so_list;    /* (e) list of unaccepted connections */
  97         u_int   so_qlen;                /* (e) number of unaccepted connections */
  98         u_int   so_incqlen;             /* (e) number of unaccepted incomplete
  99                                            connections */
 100         u_int   so_qlimit;              /* (e) max number queued connections */
 101         short   so_timeo;               /* (g) connection timeout */
 102         u_short so_error;               /* (f) error affecting connection */
 103         struct  sigio *so_sigio;        /* [sg] information for async I/O or
 104                                            out of band data (SIGURG) */
 105         u_long  so_oobmark;             /* (c) chars to oob mark */
 106
 107         struct sockbuf so_rcv, so_snd;
 108
 109         struct  ucred *so_cred;         /* (a) user credentials */
 110         struct  label *so_label;        /* (b) MAC label for socket */
 111         struct  label *so_peerlabel;    /* (b) cached MAC label for peer */
 112         /* NB: generation count must not be first. */
 113         so_gen_t so_gencnt;             /* (h) generation count */
 114         void    *so_emuldata;           /* (b) private data for emulators */
 115         struct so_accf {
 116                 struct  accept_filter *so_accept_filter;
 117                 void    *so_accept_filter_arg;  /* saved filter args */
 118                 char    *so_accept_filter_str;  /* saved user args */
 119         } *so_accf;
 120         struct  osd     osd;            /* Object Specific extensions */
 121         /*
 122          * so_fibnum, so_user_cookie and friends can be used to attach
 123          * some user-specified metadata to a socket, which then can be
 124          * used by the kernel for various actions.
 125          * so_user_cookie is used by ipfw/dummynet.
 126          */
 127         int so_fibnum;          /* routing domain for this socket */
 128         uint32_t so_user_cookie;
 129
 130         int so_ts_clock;        /* type of the clock used for timestamps */
 131
 132         void *so_pspare[2];     /* packet pacing / general use */
 133         int so_ispare[2];       /* packet pacing / general use */
 134 };
 135
 136 /*
 137  * Global accept mutex to serialize access to accept queues and
 138  * fields associated with multiple sockets.  This allows us to
 139  * avoid defining a lock order between listen and accept sockets
 140  * until such time as it proves to be a good idea.
 141  */
 142 extern struct mtx accept_mtx;
 143 #define ACCEPT_LOCK_ASSERT()            mtx_assert(&accept_mtx, MA_OWNED)
 144 #define ACCEPT_UNLOCK_ASSERT()          mtx_assert(&accept_mtx, MA_NOTOWNED)
 145 #define ACCEPT_LOCK()                   mtx_lock(&accept_mtx)
 146 #define ACCEPT_UNLOCK()                 mtx_unlock(&accept_mtx)
 147
 148 /*
 149  * Per-socket mutex: we reuse the receive socket buffer mutex for space
 150  * efficiency.  This decision should probably be revisited as we optimize
 151  * locking for the socket code.
 152  */
 153 #define SOCK_MTX(_so)                   SOCKBUF_MTX(&(_so)->so_rcv)
 154 #define SOCK_LOCK(_so)                  SOCKBUF_LOCK(&(_so)->so_rcv)
 155 #define SOCK_OWNED(_so)                 SOCKBUF_OWNED(&(_so)->so_rcv)
 156 #define SOCK_UNLOCK(_so)                SOCKBUF_UNLOCK(&(_so)->so_rcv)
 157 #define SOCK_LOCK_ASSERT(_so)           SOCKBUF_LOCK_ASSERT(&(_so)->so_rcv)
 158
 159 /*
 160  * Socket state bits stored in so_qstate.
 161  */
 162 #define SQ_INCOMP               0x0800  /* unaccepted, incomplete connection */
 163 #define SQ_COMP                 0x1000  /* unaccepted, complete connection */
 164
 165 /*
 166  * Externalized form of struct socket used by the sysctl(3) interface.
 167  */
 168 struct xsocket {
 169         size_t  xso_len;        /* length of this structure */
 170         struct  socket *xso_so; /* makes a convenient handle sometimes */
 171         short   so_type;
 172         short   so_options;
 173         short   so_linger;
 174         short   so_state;
 175         caddr_t so_pcb;         /* another convenient handle */
 176         int     xso_protocol;
 177         int     xso_family;
 178         u_int   so_qlen;
 179         u_int   so_incqlen;
 180         u_int   so_qlimit;
 181         short   so_timeo;
 182         u_short so_error;
 183         pid_t   so_pgid;
 184         u_long  so_oobmark;
 185         struct xsockbuf so_rcv, so_snd;
 186         uid_t   so_uid;         /* XXX */
 187 };
 188
 189 #ifdef _KERNEL
 190
 191 /*
 192  * Macros for sockets and socket buffering.
 193  */
 194
 195 /*
 196  * Flags to sblock().
 197  */
 198 #define SBL_WAIT        0x00000001      /* Wait if not immediately available. */
 199 #define SBL_NOINTR      0x00000002      /* Force non-interruptible sleep. */
 200 #define SBL_VALID       (SBL_WAIT | SBL_NOINTR)
 201
 202 /*
 203  * Do we need to notify the other side when I/O is possible?
 204  */
 205 #define sb_notify(sb)   (((sb)->sb_flags & (SB_WAIT | SB_SEL | SB_ASYNC | \
 206     SB_UPCALL | SB_AIO | SB_KNOTE)) != 0)
 207
 208 /* do we have to send all at once on a socket? */
 209 #define sosendallatonce(so) \
 210     ((so)->so_proto->pr_flags & PR_ATOMIC)
 211
 212 /* can we read something from so? */
 213 #define soreadabledata(so) \
 214     (sbavail(&(so)->so_rcv) >= (so)->so_rcv.sb_lowat || \
 215         !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
 216 #define soreadable(so) \
 217         (soreadabledata(so) || ((so)->so_rcv.sb_state & SBS_CANTRCVMORE))
 218
 219 /* can we write something to so? */
 220 #define sowriteable(so) \
 221     ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \
 222         (((so)->so_state&SS_ISCONNECTED) || \
 223           ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
 224      ((so)->so_snd.sb_state & SBS_CANTSENDMORE) || \
 225      (so)->so_error)
 226
 227 /*
 228  * soref()/sorele() ref-count the socket structure.  Note that you must
 229  * still explicitly close the socket, but the last ref count will free
 230  * the structure.
 231  */
 232 #define soref(so) do {                                                  \
 233         SOCK_LOCK_ASSERT(so);                                           \
 234         ++(so)->so_count;                                               \
 235 } while (0)
 236
 237 #define sorele(so) do {                                                 \
 238         ACCEPT_LOCK_ASSERT();                                           \
 239         SOCK_LOCK_ASSERT(so);                                           \
 240         if ((so)->so_count <= 0)                                        \
 241                 panic("sorele");                                        \
 242         if (--(so)->so_count == 0)                                      \
 243                 sofree(so);                                             \
 244         else {                                                          \
 245                 SOCK_UNLOCK(so);                                        \
 246                 ACCEPT_UNLOCK();                                        \
 247         }                                                               \
 248 } while (0)
 249
 250 /*
 251  * In sorwakeup() and sowwakeup(), acquire the socket buffer lock to
 252  * avoid a non-atomic test-and-wakeup.  However, sowakeup is
 253  * responsible for releasing the lock if it is called.  We unlock only
 254  * if we don't call into sowakeup.  If any code is introduced that
 255  * directly invokes the underlying sowakeup() primitives, it must
 256  * maintain the same semantics.
 257  */
 258 #define sorwakeup_locked(so) do {                                       \
 259         SOCKBUF_LOCK_ASSERT(&(so)->so_rcv);                             \
 260         if (sb_notify(&(so)->so_rcv))                                   \
 261                 sowakeup((so), &(so)->so_rcv);                          \
 262         else                                                            \
 263                 SOCKBUF_UNLOCK(&(so)->so_rcv);                          \
 264 } while (0)
 265
 266 #define sorwakeup(so) do {                                              \
 267         SOCKBUF_LOCK(&(so)->so_rcv);                                    \
 268         sorwakeup_locked(so);                                           \
 269 } while (0)
 270
 271 #define sowwakeup_locked(so) do {                                       \
 272         SOCKBUF_LOCK_ASSERT(&(so)->so_snd);                             \
 273         if (sb_notify(&(so)->so_snd))                                   \
 274                 sowakeup((so), &(so)->so_snd);                          \
 275         else                                                            \
 276                 SOCKBUF_UNLOCK(&(so)->so_snd);                          \
 277 } while (0)
 278
 279 #define sowwakeup(so) do {                                              \
 280         SOCKBUF_LOCK(&(so)->so_snd);                                    \
 281         sowwakeup_locked(so);                                           \
 282 } while (0)
 283
 284 struct accept_filter {
 285         char    accf_name[16];
 286         int     (*accf_callback)
 287                 (struct socket *so, void *arg, int waitflag);
 288         void *  (*accf_create)
 289                 (struct socket *so, char *arg);
 290         void    (*accf_destroy)
 291                 (struct socket *so);
 292         SLIST_ENTRY(accept_filter) accf_next;
 293 };
 294
 295 #ifdef MALLOC_DECLARE
 296 MALLOC_DECLARE(M_ACCF);
 297 MALLOC_DECLARE(M_PCB);
 298 MALLOC_DECLARE(M_SONAME);
 299 #endif
 300
 301 /*
 302  * Socket specific helper hook point identifiers
 303  * Do not leave holes in the sequence, hook registration is a loop.
 304  */
 305 #define HHOOK_SOCKET_OPT                0
 306 #define HHOOK_SOCKET_CREATE             1
 307 #define HHOOK_SOCKET_RCV                2
 308 #define HHOOK_SOCKET_SND                3
 309 #define HHOOK_FILT_SOREAD               4
 310 #define HHOOK_FILT_SOWRITE              5
 311 #define HHOOK_SOCKET_CLOSE              6
 312 #define HHOOK_SOCKET_LAST               HHOOK_SOCKET_CLOSE
 313
 314 struct socket_hhook_data {
 315         struct socket   *so;
 316         struct mbuf     *m;
 317         void            *hctx;          /* hook point specific data*/
 318         int             status;
 319 };
 320
 321 extern int      maxsockets;
 322 extern u_long   sb_max;
 323 extern so_gen_t so_gencnt;
 324
 325 struct file;
 326 struct filecaps;
 327 struct filedesc;
 328 struct mbuf;
 329 struct sockaddr;
 330 struct ucred;
 331 struct uio;
 332
 333 /* 'which' values for socket upcalls. */
 334 #define SO_RCV          1
 335 #define SO_SND          2
 336
 337 /* Return values for socket upcalls. */
 338 #define SU_OK           0
 339 #define SU_ISCONNECTED  1
 340
 341 /*
 342  * From uipc_socket and friends
 343  */
 344 int     getsockaddr(struct sockaddr **namp, caddr_t uaddr, size_t len);
 345 int     getsock_cap(struct thread *td, int fd, cap_rights_t *rightsp,
 346             struct file **fpp, u_int *fflagp, struct filecaps *havecaps);
 347 void    soabort(struct socket *so);
 348 int     soaccept(struct socket *so, struct sockaddr **nam);
 349 void    soaio_enqueue(struct task *task);
 350 void    soaio_rcv(void *context, int pending);
 351 void    soaio_snd(void *context, int pending);
 352 int     socheckuid(struct socket *so, uid_t uid);
 353 int     sobind(struct socket *so, struct sockaddr *nam, struct thread *td);
 354 int     sobindat(int fd, struct socket *so, struct sockaddr *nam,
 355             struct thread *td);
 356 int     soclose(struct socket *so);
 357 int     soconnect(struct socket *so, struct sockaddr *nam, struct thread *td);
 358 int     soconnectat(int fd, struct socket *so, struct sockaddr *nam,
 359             struct thread *td);
 360 int     soconnect2(struct socket *so1, struct socket *so2);
 361 int     socreate(int dom, struct socket **aso, int type, int proto,
 362             struct ucred *cred, struct thread *td);
 363 int     sodisconnect(struct socket *so);
 364 struct  sockaddr *sodupsockaddr(const struct sockaddr *sa, int mflags);
 365 void    sofree(struct socket *so);
 366 void    sohasoutofband(struct socket *so);
 367 int     solisten(struct socket *so, int backlog, struct thread *td);
 368 void    solisten_proto(struct socket *so, int backlog);
 369 int     solisten_proto_check(struct socket *so);
 370 struct socket *
 371         sonewconn(struct socket *head, int connstatus);
 372
 373
 374 int     sopoll(struct socket *so, int events, struct ucred *active_cred,
 375             struct thread *td);
 376 int     sopoll_generic(struct socket *so, int events,
 377             struct ucred *active_cred, struct thread *td);
 378 int     soreceive(struct socket *so, struct sockaddr **paddr, struct uio *uio,
 379             struct mbuf **mp0, struct mbuf **controlp, int *flagsp);
 380 int     soreceive_stream(struct socket *so, struct sockaddr **paddr,
 381             struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
 382             int *flagsp);
 383 int     soreceive_dgram(struct socket *so, struct sockaddr **paddr,
 384             struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
 385             int *flagsp);
 386 int     soreceive_generic(struct socket *so, struct sockaddr **paddr,
 387             struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
 388             int *flagsp);
 389 int     soreserve(struct socket *so, u_long sndcc, u_long rcvcc);
 390 void    sorflush(struct socket *so);
 391 int     sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
 392             struct mbuf *top, struct mbuf *control, int flags,
 393             struct thread *td);
 394 int     sosend_dgram(struct socket *so, struct sockaddr *addr,
 395             struct uio *uio, struct mbuf *top, struct mbuf *control,
 396             int flags, struct thread *td);
 397 int     sosend_generic(struct socket *so, struct sockaddr *addr,
 398             struct uio *uio, struct mbuf *top, struct mbuf *control,
 399             int flags, struct thread *td);
 400 int     soshutdown(struct socket *so, int how);
 401 void    sotoxsocket(struct socket *so, struct xsocket *xso);
 402 void    soupcall_clear(struct socket *so, int which);
 403 void    soupcall_set(struct socket *so, int which,
 404             int (*func)(struct socket *, void *, int), void *arg);
 405 void    sowakeup(struct socket *so, struct sockbuf *sb);
 406 void    sowakeup_aio(struct socket *so, struct sockbuf *sb);
 407 int     selsocket(struct socket *so, int events, struct timeval *tv,
 408             struct thread *td);
 409
 410 /*
 411  * Accept filter functions (duh).
 412  */
 413 int     accept_filt_add(struct accept_filter *filt);
 414 int     accept_filt_del(char *name);
 415 struct  accept_filter *accept_filt_get(char *name);
 416 #ifdef ACCEPT_FILTER_MOD
 417 #ifdef SYSCTL_DECL
 418 SYSCTL_DECL(_net_inet_accf);
 419 #endif
 420 int     accept_filt_generic_mod_event(module_t mod, int event, void *data);
 421 #endif
 422
 423 #endif /* _KERNEL */
 424
 425 #endif /* !_SYS_SOCKETVAR_H_ */