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. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)unpcb.h     8.1 (Berkeley) 6/2/93
  30  * $FreeBSD: src/sys/sys/unpcb.h,v 1.9.2.1 2002/03/09 05:22:23 dd Exp $
  31  * $DragonFly: src/sys/sys/unpcb.h,v 1.5 2008/05/27 05:25:36 dillon Exp $
  32  */
  33
  34 #ifndef _SYS_UNPCB_H_
  35 #define _SYS_UNPCB_H_
  36
  37 #include <sys/queue.h>
  38 #include <sys/ucred.h>
  39
  40 /*
  41  * Protocol control block for an active
  42  * instance of a UNIX internal protocol.
  43  *
  44  * A socket may be associated with an vnode in the
  45  * file system.  If so, the unp_vnode pointer holds
  46  * a reference count to this vnode, which should be irele'd
  47  * when the socket goes away.
  48  *
  49  * A socket may be connected to another socket, in which
  50  * case the control block of the socket to which it is connected
  51  * is given by unp_conn.
  52  *
  53  * A socket may be referenced by a number of sockets (e.g. several
  54  * sockets may be connected to a datagram socket.)  These sockets
  55  * are in a linked list starting with unp_refs, linked through
  56  * unp_nextref and null-terminated.  Note that a socket may be referenced
  57  * by a number of other sockets and may also reference a socket (not
  58  * necessarily one which is referencing it).  This generates
  59  * the need for unp_refs and unp_nextref to be separate fields.
  60  *
  61  * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
  62  * so that changes in the sockbuf may be computed to modify
  63  * back pressure on the sender accordingly.
  64  */
  65 typedef u_quad_t        unp_gen_t;
  66 LIST_HEAD(unp_head, unpcb);
  67
  68 struct  unpcb {
  69         struct socket   *unp_socket;    /* pointer back to socket */
  70         struct unpcb    *unp_conn;      /* control block of connected socket */
  71         int             unp_flags;      /* flags */
  72         int             unp_refcnt;     /* referece count */
  73         struct unp_head unp_refs;       /* referencing socket linked list */
  74         LIST_ENTRY(unpcb) unp_reflink;  /* link in unp_refs list */
  75         struct sockaddr_un *unp_addr;   /* bound address of socket */
  76         struct xucred   unp_peercred;   /* peer credentials, if applicable */
  77         int             unp_msgcount;   /* # of cmsgs this unp are in */
  78         int             unp_gcflags;    /* flags reserved for unp GC to use */
  79         struct file     *unp_fp;        /* cooresponding fp if unp is in cmsg */
  80         ino_t           unp_ino;        /* fake inode number */
  81         struct vnode    *unp_vnode;     /* if associated with file */
  82         struct vnode    *unp_rvnode;    /* root vp for creating process */
  83         TAILQ_ENTRY(unpcb) unp_link;    /* glue on list of all PCBs */
  84         unp_gen_t       unp_gencnt;     /* generation count of this instance */
  85 };
  86
  87 /*
  88  * Flags in unp_flags.
  89  *
  90  * UNP_HAVEPC - indicates that the unp_peercred member is filled in
  91  * and is really the credentials of the connected peer.  This is used
  92  * to determine whether the contents should be sent to the user or
  93  * not.
  94  *
  95  * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
  96  * in, but does *not* contain the credentials of the connected peer
  97  * (there may not even be a peer).  This is set in unp_listen() when
  98  * it fills in unp_peercred for later consumption by unp_connect().
  99  *
 100  * UNP_PRIVATE{1,2,3,4} - Implementation private.
 101  */
 102 #define UNP_HAVEPC                      0x001
 103 #define UNP_HAVEPCCACHED                0x002
 104 #define UNP_PRIVATE1                    0x004
 105 #define UNP_PRIVATE2                    0x008
 106 #define UNP_PRIVATE3                    0x010
 107 #define UNP_PRIVATE4                    0x020
 108
 109 /* Hack alert -- this structure depends on <sys/socketvar.h>. */
 110 #ifdef  _SYS_SOCKETVAR_H_
 111 struct  xunpcb {
 112         size_t  xu_len;                 /* length of this structure */
 113         struct  unpcb *xu_unpp;         /* to help netstat, fstat */
 114         struct  unpcb xu_unp;           /* our information */
 115         union {
 116                 struct  sockaddr_un xuu_addr;   /* our bound address */
 117                 char    xu_dummy1[256];
 118         } xu_au;
 119 #define xu_addr xu_au.xuu_addr
 120         union {
 121                 struct  sockaddr_un xuu_caddr; /* their bound address */
 122                 char    xu_dummy2[256];
 123         } xu_cau;
 124 #define xu_caddr xu_cau.xuu_caddr
 125         struct  xsocket xu_socket;
 126         u_quad_t        xu_alignment_hack;
 127 };
 128 #endif /* _SYS_SOCKETVAR_H_ */
 129
 130 #endif /* _SYS_UNPCB_H_ */