bsd/sys/unpcb.h

   1 /*
   2  * Copyright (c) 2008-2010 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1982, 1986, 1989, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)unpcb.h     8.1 (Berkeley) 6/2/93
  61  */
  62
  63 #ifndef _SYS_UNPCB_H_
  64 #define _SYS_UNPCB_H_
  65
  66 #include <sys/appleapiopts.h>
  67 #include <sys/queue.h>
  68 #include <sys/un.h>
  69 #include <sys/ucred.h>
  70
  71 /*
  72  * Protocol control block for an active
  73  * instance of a UNIX internal protocol.
  74  *
  75  * A socket may be associated with an vnode in the
  76  * file system.  If so, the unp_vnode pointer holds
  77  * a reference count to this vnode, which should be irele'd
  78  * when the socket goes away.
  79  *
  80  * A socket may be connected to another socket, in which
  81  * case the control block of the socket to which it is connected
  82  * is given by unp_conn.
  83  *
  84  * A socket may be referenced by a number of sockets (e.g. several
  85  * sockets may be connected to a datagram socket.)  These sockets
  86  * are in a linked list starting with unp_refs, linked through
  87  * unp_nextref and null-terminated.  Note that a socket may be referenced
  88  * by a number of other sockets and may also reference a socket (not
  89  * necessarily one which is referencing it).  This generates
  90  * the need for unp_refs and unp_nextref to be separate fields.
  91  *
  92  * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
  93  * so that changes in the sockbuf may be computed to modify
  94  * back pressure on the sender accordingly.
  95  */
  96
  97 typedef u_quad_t        unp_gen_t;
  98
  99 #if defined(__LP64__)
 100 struct _unpcb_list_entry {
 101     u_int32_t   le_next;
 102     u_int32_t   le_prev;
 103 };
 104 #define _UCPCB_LIST_HEAD(name, type)    \
 105 struct name {                           \
 106         u_int32_t       lh_first;       \
 107 };
 108 #define _UNPCB_LIST_ENTRY(x)            struct _unpcb_list_entry
 109 #define _UNPCB_PTR(x)                   u_int32_t
 110 #else
 111 #define _UCPCB_LIST_HEAD(name, type)    LIST_HEAD(name, type)
 112 #define _UNPCB_LIST_ENTRY(x)            LIST_ENTRY(x)
 113 #define _UNPCB_PTR(x)                   x
 114 #endif
 115
 116 #ifdef PRIVATE
 117 #ifndef KERNEL
 118 _UCPCB_LIST_HEAD(unp_head, unpcb);
 119 #else
 120 LIST_HEAD(unp_head, unpcb);
 121 #define sotounpcb(so)   ((struct unpcb *)((so)->so_pcb))
 122
 123 struct  unpcb {
 124         LIST_ENTRY(unpcb) unp_link;     /* glue on list of all PCBs */
 125         struct socket   *unp_socket;    /* pointer back to socket */
 126         struct vnode    *unp_vnode;     /* if associated with file */
 127         ino_t                   unp_ino;        /* fake inode number */
 128         struct unpcb    *unp_conn;      /* control block of connected socket */
 129         struct unp_head unp_refs;       /* referencing socket linked list */
 130         LIST_ENTRY(unpcb) unp_reflink;  /* link in unp_refs list */
 131         struct sockaddr_un *unp_addr;   /* bound address of socket */
 132         int             unp_cc;         /* copy of rcv.sb_cc */
 133         int             unp_mbcnt;      /* copy of rcv.sb_mbcnt */
 134         unp_gen_t       unp_gencnt;     /* generation count of this instance */
 135         int             unp_flags;      /* flags */
 136         struct xucred   unp_peercred;   /* peer credentials, if applicable */
 137         decl_lck_mtx_data( ,unp_mtx);   /* per unpcb lock */
 138         int             rw_thrcount;    /* disconnect should wait for this count to become zero */
 139 };
 140 #endif /* KERNEL */
 141
 142 /*
 143  * Flags in unp_flags.
 144  *
 145  * UNP_HAVEPC - indicates that the unp_peercred member is filled in
 146  * and is really the credentials of the connected peer.  This is used
 147  * to determine whether the contents should be sent to the user or
 148  * not.
 149  *
 150  * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
 151  * in, but does *not* contain the credentials of the connected peer
 152  * (there may not even be a peer).  This is set in unp_listen() when
 153  * it fills in unp_peercred for later consumption by unp_connect().
 154  */
 155 #define UNP_HAVEPC                      0x0001
 156 #define UNP_HAVEPCCACHED                0x0002
 157 #define UNP_DONTDISCONNECT              0x0004
 158 #define UNP_TRACE_MDNS                  0x1000
 159
 160 #ifdef KERNEL
 161 struct  unpcb_compat {
 162 #else /* KERNEL */
 163 #define unpcb_compat unpcb
 164 struct  unpcb {
 165 #endif /* KERNEL */
 166         _UNPCB_LIST_ENTRY(unpcb_compat) unp_link;       /* glue on list of all PCBs */
 167         _UNPCB_PTR(struct socket *)     unp_socket;     /* pointer back to socket */
 168         _UNPCB_PTR(struct vnode *)      unp_vnode;      /* if associated with file */
 169         ino_t                           unp_ino;        /* fake inode number */
 170         _UNPCB_PTR(struct unpcb_compat *) unp_conn;     /* control block of connected socket */
 171 #if defined(KERNEL)
 172         u_int32_t                       unp_refs;
 173 #else
 174         struct unp_head                 unp_refs;       /* referencing socket linked list */
 175 #endif
 176         _UNPCB_LIST_ENTRY(unpcb_compat) unp_reflink;    /* link in unp_refs list */
 177         _UNPCB_PTR(struct sockaddr_un *) unp_addr;      /* bound address of socket */
 178         int                             unp_cc;         /* copy of rcv.sb_cc */
 179         int                             unp_mbcnt;      /* copy of rcv.sb_mbcnt */
 180         unp_gen_t                       unp_gencnt;     /* generation count of this instance */
 181 };
 182
 183 /* Hack alert -- this structure depends on <sys/socketvar.h>. */
 184 #ifdef  _SYS_SOCKETVAR_H_
 185
 186 #pragma pack(4)
 187
 188 struct  xunpcb {
 189         u_int32_t                       xu_len;         /* length of this structure */
 190         _UNPCB_PTR(struct unpcb_compat *) xu_unpp;      /* to help netstat, fstat */
 191         struct unpcb_compat             xu_unp;         /* our information */
 192         union {
 193                 struct sockaddr_un      xuu_addr;       /* our bound address */
 194                 char                    xu_dummy1[256];
 195         } xu_au;
 196 #define xu_addr xu_au.xuu_addr
 197         union {
 198                 struct sockaddr_un      xuu_caddr;      /* their bound address */
 199                 char                    xu_dummy2[256];
 200         } xu_cau;
 201 #define xu_caddr xu_cau.xuu_caddr
 202         struct xsocket                  xu_socket;
 203         u_quad_t                        xu_alignment_hack;
 204 };
 205
 206 #if !CONFIG_EMBEDDED
 207
 208 struct xunpcb64_list_entry {
 209     u_int64_t   le_next;
 210     u_int64_t   le_prev;
 211 };
 212
 213 struct xunpcb64 {
 214         u_int32_t                       xu_len;         /* length of this structure */
 215         u_int64_t                       xu_unpp;        /* to help netstat, fstat */
 216         struct xunpcb64_list_entry      xunp_link;      /* glue on list of all PCBs */
 217         u_int64_t                       xunp_socket;    /* pointer back to socket */
 218         u_int64_t                       xunp_vnode;     /* if associated with file */
 219         u_int64_t                       xunp_ino;       /* fake inode number */
 220         u_int64_t                       xunp_conn;      /* control block of connected socket */
 221         u_int64_t                       xunp_refs;      /* referencing socket linked list */
 222         struct xunpcb64_list_entry      xunp_reflink;   /* link in unp_refs list */
 223         int                             xunp_cc;                /* copy of rcv.sb_cc */
 224         int                             xunp_mbcnt;     /* copy of rcv.sb_mbcnt */
 225         unp_gen_t                       xunp_gencnt;    /* generation count of this instance */
 226         int                             xunp_flags;     /* flags */
 227         union {
 228                 struct sockaddr_un              xuu_addr;
 229                 char                            xu_dummy1[256];
 230         }                               xu_au;          /* our bound address */
 231 #define xunp_addr xu_au.xuu_addr
 232         union {
 233                 struct sockaddr_un              xuu_caddr;
 234                 char                            xu_dummy2[256];
 235         }                               xu_cau;         /* their bound address */
 236 #define xunp_caddr xu_cau.xuu_caddr
 237         struct xsocket64        xu_socket;
 238 };
 239
 240 #endif /* !CONFIG_EMBEDDED */
 241
 242 #pragma pack()
 243
 244 #endif /* _SYS_SOCKETVAR_H_ */
 245
 246 #endif /* PRIVATE */
 247
 248 struct  xunpgen {
 249         u_int32_t       xug_len;
 250         u_int           xug_count;
 251         unp_gen_t       xug_gen;
 252         so_gen_t        xug_sogen;
 253 };
 254
 255 #endif /* _SYS_UNPCB_H_ */