bsd/sys/unpcb.h

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