bsd/sys/unpcb.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, 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 #ifdef PRIVATE
 100 LIST_HEAD(unp_head, unpcb);
 101 #ifdef KERNEL
 102 #define sotounpcb(so)   ((struct unpcb *)((so)->so_pcb))
 103
 104 struct  unpcb {
 105         LIST_ENTRY(unpcb) unp_link;     /* glue on list of all PCBs */
 106         struct  socket *unp_socket;     /* pointer back to socket */
 107         struct  vnode *unp_vnode;       /* if associated with file */
 108         ino_t   unp_ino;                /* fake inode number */
 109         struct  unpcb *unp_conn;        /* control block of connected socket */
 110         struct  unp_head unp_refs;      /* referencing socket linked list */
 111         LIST_ENTRY(unpcb) unp_reflink;  /* link in unp_refs list */
 112         struct  sockaddr_un *unp_addr;  /* bound address of socket */
 113         int     unp_cc;                 /* copy of rcv.sb_cc */
 114         int     unp_mbcnt;              /* copy of rcv.sb_mbcnt */
 115         unp_gen_t unp_gencnt;           /* generation count of this instance */
 116         int     unp_flags;              /* flags */
 117         struct  xucred unp_peercred;    /* peer credentials, if applicable */
 118 };
 119 #endif /* KERNEL */
 120
 121 /*
 122  * Flags in unp_flags.
 123  *
 124  * UNP_HAVEPC - indicates that the unp_peercred member is filled in
 125  * and is really the credentials of the connected peer.  This is used
 126  * to determine whether the contents should be sent to the user or
 127  * not.
 128  *
 129  * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
 130  * in, but does *not* contain the credentials of the connected peer
 131  * (there may not even be a peer).  This is set in unp_listen() when
 132  * it fills in unp_peercred for later consumption by unp_connect().
 133  */
 134 #define UNP_HAVEPC                      0x001
 135 #define UNP_HAVEPCCACHED                0x002
 136
 137 #ifdef KERNEL
 138 struct  unpcb_compat {
 139 #else /* KERNEL */
 140 #define unpcb_compat unpcb
 141 struct  unpcb {
 142 #endif /* KERNEL */
 143         LIST_ENTRY(unpcb_compat) unp_link;     /* glue on list of all PCBs */
 144         struct  socket *unp_socket;     /* pointer back to socket */
 145         struct  vnode *unp_vnode;       /* if associated with file */
 146         ino_t   unp_ino;                /* fake inode number */
 147         struct  unpcb_compat *unp_conn;        /* control block of connected socket */
 148         struct  unp_head unp_refs;      /* referencing socket linked list */
 149         LIST_ENTRY(unpcb_compat) unp_reflink;  /* link in unp_refs list */
 150         struct  sockaddr_un *unp_addr;  /* bound address of socket */
 151         int     unp_cc;                 /* copy of rcv.sb_cc */
 152         int     unp_mbcnt;              /* copy of rcv.sb_mbcnt */
 153         unp_gen_t unp_gencnt;           /* generation count of this instance */
 154 };
 155
 156 /* Hack alert -- this structure depends on <sys/socketvar.h>. */
 157 #ifdef  _SYS_SOCKETVAR_H_
 158 struct  xunpcb {
 159         size_t  xu_len;                 /* length of this structure */
 160         struct  unpcb_compat *xu_unpp;         /* to help netstat, fstat */
 161         struct  unpcb_compat xu_unp;           /* our information */
 162         union {
 163                 struct  sockaddr_un xuu_addr;   /* our bound address */
 164                 char    xu_dummy1[256];
 165         } xu_au;
 166 #define xu_addr xu_au.xuu_addr
 167         union {
 168                 struct  sockaddr_un xuu_caddr; /* their bound address */
 169                 char    xu_dummy2[256];
 170         } xu_cau;
 171 #define xu_caddr xu_cau.xuu_caddr
 172         struct  xsocket xu_socket;
 173         u_quad_t        xu_alignment_hack;
 174 };
 175 #endif /* _SYS_SOCKETVAR_H_ */
 176 #endif /* PRIVATE */
 177
 178 struct  xunpgen {
 179         size_t  xug_len;
 180         u_int   xug_count;
 181         unp_gen_t xug_gen;
 182         so_gen_t xug_sogen;
 183 };
 184
 185 #endif /* _SYS_UNPCB_H_ */