unpcb.h revision 108470 
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: head/sys/sys/unpcb.h 108470 2002-12-30 21:18:15Z schweikh $
35 */
36
37#ifndef _SYS_UNPCB_H_
38#define _SYS_UNPCB_H_
39
40#include <sys/queue.h>
41#include <sys/ucred.h>
42
43/*
44 * Protocol control block for an active
45 * instance of a UNIX internal protocol.
46 *
47 * A socket may be associated with a vnode in the
48 * filesystem.  If so, the unp_vnode pointer holds
49 * a reference count to this vnode, which should be irele'd
50 * when the socket goes away.
51 *
52 * A socket may be connected to another socket, in which
53 * case the control block of the socket to which it is connected
54 * is given by unp_conn.
55 *
56 * A socket may be referenced by a number of sockets (e.g. several
57 * sockets may be connected to a datagram socket.)  These sockets
58 * are in a linked list starting with unp_refs, linked through
59 * unp_nextref and null-terminated.  Note that a socket may be referenced
60 * by a number of other sockets and may also reference a socket (not
61 * necessarily one which is referencing it).  This generates
62 * the need for unp_refs and unp_nextref to be separate fields.
63 *
64 * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
65 * so that changes in the sockbuf may be computed to modify
66 * back pressure on the sender accordingly.
67 */
68typedef	u_quad_t	unp_gen_t;
69LIST_HEAD(unp_head, unpcb);
70
71struct unpcb {
72	LIST_ENTRY(unpcb) unp_link; 	/* glue on list of all PCBs */
73	struct	socket *unp_socket;	/* pointer back to socket */
74	struct	vnode *unp_vnode;	/* if associated with file */
75	struct	vnode *unp_rvnode;	/* root vp for creating process */
76	ino_t	unp_ino;		/* fake inode number */
77	struct	unpcb *unp_conn;	/* control block of connected socket */
78	struct	unp_head unp_refs;	/* referencing socket linked list */
79	LIST_ENTRY(unpcb) unp_reflink;	/* link in unp_refs list */
80	struct	sockaddr_un *unp_addr;	/* bound address of socket */
81	int	unp_cc;			/* copy of rcv.sb_cc */
82	int	unp_mbcnt;		/* copy of rcv.sb_mbcnt */
83	unp_gen_t unp_gencnt;		/* generation count of this instance */
84	int	unp_flags;		/* flags */
85	struct	xucred unp_peercred;	/* peer credentials, if applicable */
86};
87
88/*
89 * Flags in unp_flags.
90 *
91 * UNP_HAVEPC - indicates that the unp_peercred member is filled in
92 * and is really the credentials of the connected peer.  This is used
93 * to determine whether the contents should be sent to the user or
94 * not.
95 *
96 * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
97 * in, but does *not* contain the credentials of the connected peer
98 * (there may not even be a peer).  This is set in unp_listen() when
99 * it fills in unp_peercred for later consumption by unp_connect().
100 */
101#define UNP_HAVEPC			0x001
102#define UNP_HAVEPCCACHED		0x002
103
104#define	sotounpcb(so)	((struct unpcb *)((so)->so_pcb))
105
106/* Hack alert -- this structure depends on <sys/socketvar.h>. */
107#ifdef	_SYS_SOCKETVAR_H_
108struct xunpcb {
109	size_t	xu_len;			/* length of this structure */
110	struct	unpcb *xu_unpp;		/* to help netstat, fstat */
111	struct	unpcb xu_unp;		/* our information */
112	union {
113		struct	sockaddr_un xuu_addr;	/* our bound address */
114		char	xu_dummy1[256];
115	} xu_au;
116#define	xu_addr	xu_au.xuu_addr
117	union {
118		struct	sockaddr_un xuu_caddr; /* their bound address */
119		char	xu_dummy2[256];
120	} xu_cau;
121#define	xu_caddr xu_cau.xuu_caddr
122	struct	xsocket	xu_socket;
123	u_quad_t	xu_alignment_hack;
124};
125
126struct xunpgen {
127	size_t	xug_len;
128	u_int	xug_count;
129	unp_gen_t xug_gen;
130	so_gen_t xug_sogen;
131};
132#endif /* _SYS_SOCKETVAR_H_ */
133
134#endif /* _SYS_UNPCB_H_ */
135