bsd/sys/unpcb.h

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