bsd/sys/unpcb.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright (c) 1982, 1986, 1989, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by the University of
  38  *      California, Berkeley and its contributors.
  39  * 4. Neither the name of the University nor the names of its contributors
  40  *    may be used to endorse or promote products derived from this software
  41  *    without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  *
  55  *      @(#)unpcb.h     8.1 (Berkeley) 6/2/93
  56  */
  57
  58 #ifndef _SYS_UNPCB_H_
  59 #define _SYS_UNPCB_H_
  60
  61 #include <sys/appleapiopts.h>
  62 #include <sys/queue.h>
  63 #include <sys/un.h>
  64 #include <sys/ucred.h>
  65
  66 /*
  67  * Protocol control block for an active
  68  * instance of a UNIX internal protocol.
  69  *
  70  * A socket may be associated with an vnode in the
  71  * file system.  If so, the unp_vnode pointer holds
  72  * a reference count to this vnode, which should be irele'd
  73  * when the socket goes away.
  74  *
  75  * A socket may be connected to another socket, in which
  76  * case the control block of the socket to which it is connected
  77  * is given by unp_conn.
  78  *
  79  * A socket may be referenced by a number of sockets (e.g. several
  80  * sockets may be connected to a datagram socket.)  These sockets
  81  * are in a linked list starting with unp_refs, linked through
  82  * unp_nextref and null-terminated.  Note that a socket may be referenced
  83  * by a number of other sockets and may also reference a socket (not
  84  * necessarily one which is referencing it).  This generates
  85  * the need for unp_refs and unp_nextref to be separate fields.
  86  *
  87  * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
  88  * so that changes in the sockbuf may be computed to modify
  89  * back pressure on the sender accordingly.
  90  */
  91
  92 typedef u_quad_t        unp_gen_t;
  93
  94 #ifdef PRIVATE
  95 LIST_HEAD(unp_head, unpcb);
  96 #ifdef KERNEL
  97 #define sotounpcb(so)   ((struct unpcb *)((so)->so_pcb))
  98
  99 struct  unpcb {
 100         LIST_ENTRY(unpcb) unp_link;     /* glue on list of all PCBs */
 101         struct  socket *unp_socket;     /* pointer back to socket */
 102         struct  vnode *unp_vnode;       /* if associated with file */
 103         ino_t   unp_ino;                /* fake inode number */
 104         struct  unpcb *unp_conn;        /* control block of connected socket */
 105         struct  unp_head unp_refs;      /* referencing socket linked list */
 106         LIST_ENTRY(unpcb) unp_reflink;  /* link in unp_refs list */
 107         struct  sockaddr_un *unp_addr;  /* bound address of socket */
 108         int     unp_cc;                 /* copy of rcv.sb_cc */
 109         int     unp_mbcnt;              /* copy of rcv.sb_mbcnt */
 110         unp_gen_t unp_gencnt;           /* generation count of this instance */
 111         int     unp_flags;              /* flags */
 112         struct  xucred unp_peercred;    /* peer credentials, if applicable */
 113 };
 114 #endif /* KERNEL */
 115
 116 /*
 117  * Flags in unp_flags.
 118  *
 119  * UNP_HAVEPC - indicates that the unp_peercred member is filled in
 120  * and is really the credentials of the connected peer.  This is used
 121  * to determine whether the contents should be sent to the user or
 122  * not.
 123  *
 124  * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
 125  * in, but does *not* contain the credentials of the connected peer
 126  * (there may not even be a peer).  This is set in unp_listen() when
 127  * it fills in unp_peercred for later consumption by unp_connect().
 128  */
 129 #define UNP_HAVEPC                      0x001
 130 #define UNP_HAVEPCCACHED                0x002
 131
 132 #ifdef KERNEL
 133 struct  unpcb_compat {
 134 #else /* KERNEL */
 135 #define unpcb_compat unpcb
 136 struct  unpcb {
 137 #endif /* KERNEL */
 138         LIST_ENTRY(unpcb_compat) unp_link;     /* glue on list of all PCBs */
 139         struct  socket *unp_socket;     /* pointer back to socket */
 140         struct  vnode *unp_vnode;       /* if associated with file */
 141         ino_t   unp_ino;                /* fake inode number */
 142         struct  unpcb_compat *unp_conn;        /* control block of connected socket */
 143         struct  unp_head unp_refs;      /* referencing socket linked list */
 144         LIST_ENTRY(unpcb_compat) unp_reflink;  /* link in unp_refs list */
 145         struct  sockaddr_un *unp_addr;  /* bound address of socket */
 146         int     unp_cc;                 /* copy of rcv.sb_cc */
 147         int     unp_mbcnt;              /* copy of rcv.sb_mbcnt */
 148         unp_gen_t unp_gencnt;           /* generation count of this instance */
 149 };
 150
 151 /* Hack alert -- this structure depends on <sys/socketvar.h>. */
 152 #ifdef  _SYS_SOCKETVAR_H_
 153 struct  xunpcb {
 154         size_t  xu_len;                 /* length of this structure */
 155         struct  unpcb_compat *xu_unpp;         /* to help netstat, fstat */
 156         struct  unpcb_compat xu_unp;           /* our information */
 157         union {
 158                 struct  sockaddr_un xuu_addr;   /* our bound address */
 159                 char    xu_dummy1[256];
 160         } xu_au;
 161 #define xu_addr xu_au.xuu_addr
 162         union {
 163                 struct  sockaddr_un xuu_caddr; /* their bound address */
 164                 char    xu_dummy2[256];
 165         } xu_cau;
 166 #define xu_caddr xu_cau.xuu_caddr
 167         struct  xsocket xu_socket;
 168         u_quad_t        xu_alignment_hack;
 169 };
 170 #endif /* _SYS_SOCKETVAR_H_ */
 171 #endif /* PRIVATE */
 172
 173 struct  xunpgen {
 174         size_t  xug_len;
 175         u_int   xug_count;
 176         unp_gen_t xug_gen;
 177         so_gen_t xug_sogen;
 178 };
 179
 180 #endif /* _SYS_UNPCB_H_ */