sys/sys/unpcb.h

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