sys/sys/unpcb.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1989, 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. 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  *      @(#)unpcb.h     8.1 (Berkeley) 6/2/93
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_UNPCB_H_
  34 #define _SYS_UNPCB_H_
  35
  36 typedef uint64_t unp_gen_t;
  37
  38 #if defined(_KERNEL) || defined(_WANT_UNPCB)
  39 #include <sys/queue.h>
  40 #include <sys/ucred.h>
  41
  42 /*
  43  * Protocol control block for an active
  44  * instance of a UNIX internal protocol.
  45  *
  46  * A socket may be associated with a vnode in the
  47  * filesystem.  If so, the unp_vnode pointer holds
  48  * a reference count to this vnode, which should be irele'd
  49  * when the socket goes away.
  50  *
  51  * A socket may be connected to another socket, in which
  52  * case the control block of the socket to which it is connected
  53  * is given by unp_conn.
  54  *
  55  * A socket may be referenced by a number of sockets (e.g. several
  56  * sockets may be connected to a datagram socket.)  These sockets
  57  * are in a linked list starting with unp_refs, linked through
  58  * unp_nextref and null-terminated.  Note that a socket may be referenced
  59  * by a number of other sockets and may also reference a socket (not
  60  * necessarily one which is referencing it).  This generates
  61  * the need for unp_refs and unp_nextref to be separate fields.
  62  *
  63  * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
  64  * so that changes in the sockbuf may be computed to modify
  65  * back pressure on the sender accordingly.
  66  */
  67 LIST_HEAD(unp_head, unpcb);
  68
  69 struct unpcb {
  70         LIST_ENTRY(unpcb) unp_link;     /* glue on list of all PCBs */
  71         struct  socket *unp_socket;     /* pointer back to socket */
  72         struct  file *unp_file;         /* back-pointer to file for gc. */
  73         struct  vnode *unp_vnode;       /* if associated with file */
  74         ino_t   unp_ino;                /* fake inode number */
  75         struct  unpcb *unp_conn;        /* control block of connected socket */
  76         struct  unp_head unp_refs;      /* referencing socket linked list */
  77         LIST_ENTRY(unpcb) unp_reflink;  /* link in unp_refs list */
  78         struct  sockaddr_un *unp_addr;  /* bound address of socket */
  79         unp_gen_t unp_gencnt;           /* generation count of this instance */
  80         short   unp_flags;              /* flags */
  81         short   unp_gcflag;             /* Garbage collector flags. */
  82         struct  xucred unp_peercred;    /* peer credentials, if applicable */
  83         u_int   unp_refcount;
  84         u_int   unp_msgcount;           /* references from message queue */
  85         struct  mtx unp_mtx;            /* mutex */
  86 };
  87
  88 /*
  89  * Flags in unp_flags.
  90  *
  91  * UNP_HAVEPC - indicates that the unp_peercred member is filled in
  92  * and is really the credentials of the connected peer.  This is used
  93  * to determine whether the contents should be sent to the user or
  94  * not.
  95  */
  96 #define UNP_HAVEPC                      0x001
  97 #define UNP_WANTCRED                    0x004   /* credentials wanted */
  98 #define UNP_CONNWAIT                    0x008   /* connect blocks until accepted */
  99
 100 /*
 101  * These flags are used to handle non-atomicity in connect() and bind()
 102  * operations on a socket: in particular, to avoid races between multiple
 103  * threads or processes operating simultaneously on the same socket.
 104  */
 105 #define UNP_CONNECTING                  0x010   /* Currently connecting. */
 106 #define UNP_BINDING                     0x020   /* Currently binding. */
 107 #define UNP_NASCENT                     0x040   /* Newborn child socket. */
 108
 109 /*
 110  * Flags in unp_gcflag.
 111  */
 112 #define UNPGC_REF                       0x1     /* unpcb has external ref. */
 113 #define UNPGC_DEAD                      0x2     /* unpcb might be dead. */
 114 #define UNPGC_SCANNED                   0x4     /* Has been scanned. */
 115 #define UNPGC_IGNORE_RIGHTS             0x8     /* Attached rights are freed */
 116
 117 #define sotounpcb(so)   ((struct unpcb *)((so)->so_pcb))
 118
 119 #endif  /* _KERNEL || _WANT_UNPCB */
 120
 121 /*
 122  * UNPCB structure exported to user-land via sysctl(3).
 123  *
 124  * Fields prefixed with "xu_" are unique to the export structure, and fields
 125  * with "unp_" or other prefixes match corresponding fields of 'struct unpcb'.
 126  *
 127  * Legend:
 128  * (s) - used by userland utilities in src
 129  * (p) - used by utilities in ports
 130  * (3) - is known to be used by third party software not in ports
 131  * (n) - no known usage
 132  *
 133  * Evil hack: declare only if sys/socketvar.h have been included.
 134  */
 135 #ifdef  _SYS_SOCKETVAR_H_
 136 struct xunpcb {
 137         size_t          xu_len;                 /* length of this structure */
 138         void            *xu_unpp;               /* to help netstat, fstat */
 139         void            *unp_vnode;             /* (s) */
 140         void            *unp_conn;              /* (s) */
 141         void            *xu_firstref;           /* (s) */
 142         void            *xu_nextref;            /* (s) */
 143         unp_gen_t       unp_gencnt;             /* (s) */
 144         int64_t         xu_spare64[8];
 145         int32_t         xu_spare32[8];
 146         union {
 147                 struct  sockaddr_un xu_addr;    /* our bound address */
 148                 char    xu_dummy1[256];
 149         };
 150         union {
 151                 struct  sockaddr_un xu_caddr;   /* their bound address */
 152                 char    xu_dummy2[256];
 153         };
 154         struct xsocket  xu_socket;
 155 } __aligned(8);
 156
 157 struct xunpgen {
 158         size_t  xug_len;
 159         u_int   xug_count;
 160         unp_gen_t xug_gen;
 161         so_gen_t xug_sogen;
 162 } __aligned(8);;
 163 #endif /* _SYS_SOCKETVAR_H_ */
 164
 165 #endif /* _SYS_UNPCB_H_ */