1/*
2 * Copyright (c) 2008-2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * Copyright (c) 1982, 1986, 1989, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * @(#)unpcb.h 8.1 (Berkeley) 6/2/93
61 */
62
63#ifndef _SYS_UNPCB_H_
64#define _SYS_UNPCB_H_
65
66#include <sys/appleapiopts.h>
67#include <sys/queue.h>
68#include <sys/un.h>
69#include <sys/ucred.h>
70#include <sys/socketvar.h>
71
72/*
73 * Protocol control block for an active
74 * instance of a UNIX internal protocol.
75 *
76 * A socket may be associated with an vnode in the
77 * file system. If so, the unp_vnode pointer holds
78 * a reference count to this vnode, which should be irele'd
79 * when the socket goes away.
80 *
81 * A socket may be connected to another socket, in which
82 * case the control block of the socket to which it is connected
83 * is given by unp_conn.
84 *
85 * A socket may be referenced by a number of sockets (e.g. several
86 * sockets may be connected to a datagram socket.) These sockets
87 * are in a linked list starting with unp_refs, linked through
88 * unp_nextref and null-terminated. Note that a socket may be referenced
89 * by a number of other sockets and may also reference a socket (not
90 * necessarily one which is referencing it). This generates
91 * the need for unp_refs and unp_nextref to be separate fields.
92 *
93 * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
94 * so that changes in the sockbuf may be computed to modify
95 * back pressure on the sender accordingly.
96 */
97
98typedef u_quad_t unp_gen_t;
99
100#if defined(__LP64__)
101struct _unpcb_list_entry {
102 u_int32_t le_next;
103 u_int32_t le_prev;
104};
105#define _UCPCB_LIST_HEAD(name, type) \
106struct name { \
107 u_int32_t lh_first; \
108};
109#define _UNPCB_LIST_ENTRY(x) struct _unpcb_list_entry
110#define _UNPCB_PTR(x) u_int32_t
111#else
112#define _UCPCB_LIST_HEAD(name, type) LIST_HEAD(name, type)
113#define _UNPCB_LIST_ENTRY(x) LIST_ENTRY(x)
114#define _UNPCB_PTR(x) x
115#endif
116
117#ifdef PRIVATE
118#ifndef KERNEL
119_UCPCB_LIST_HEAD(unp_head, unpcb);
120#else
121LIST_HEAD(unp_head, unpcb);
122#define sotounpcb(so) ((struct unpcb *)((so)->so_pcb))
123
124struct unpcb {
125 LIST_ENTRY(unpcb) unp_link; /* glue on list of all PCBs */
126 struct socket *unp_socket; /* pointer back to socket */
127 struct vnode *unp_vnode; /* if associated with file */
128 ino_t unp_ino; /* fake inode number */
129 struct unpcb *unp_conn; /* control block of connected socket */
130 struct unp_head unp_refs; /* referencing socket linked list */
131 LIST_ENTRY(unpcb) unp_reflink; /* link in unp_refs list */
132 struct sockaddr_un *unp_addr; /* bound address of socket */
133 int unp_cc; /* copy of rcv.sb_cc */
134 int unp_mbcnt; /* copy of rcv.sb_mbcnt */
135 unp_gen_t unp_gencnt; /* generation count of this instance */
136 int unp_flags; /* flags */
137 struct xucred unp_peercred; /* peer credentials, if applicable */
138 decl_lck_mtx_data( ,unp_mtx); /* per unpcb lock */
139 int rw_thrcount; /* disconnect should wait for this count to become zero */
140};
141#endif /* KERNEL */
142
143/*
144 * Flags in unp_flags.
145 *
146 * UNP_HAVEPC - indicates that the unp_peercred member is filled in
147 * and is really the credentials of the connected peer. This is used
148 * to determine whether the contents should be sent to the user or
149 * not.
150 *
151 * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
152 * in, but does *not* contain the credentials of the connected peer
153 * (there may not even be a peer). This is set in unp_listen() when
154 * it fills in unp_peercred for later consumption by unp_connect().
155 */
156#define UNP_HAVEPC 0x0001
157#define UNP_HAVEPCCACHED 0x0002
158#define UNP_DONTDISCONNECT 0x0004
159#define UNP_TRACE_MDNS 0x1000
160
161#ifdef KERNEL
162struct unpcb_compat {
163#else /* KERNEL */
164#define unpcb_compat unpcb
165struct unpcb {
166#endif /* KERNEL */
167 _UNPCB_LIST_ENTRY(unpcb_compat) unp_link; /* glue on list of all PCBs */
168 _UNPCB_PTR(struct socket *) unp_socket; /* pointer back to socket */
169 _UNPCB_PTR(struct vnode *) unp_vnode; /* if associated with file */
170 u_int32_t unp_ino; /* fake inode number */
171 _UNPCB_PTR(struct unpcb_compat *) unp_conn; /* control block of connected socket */
172#if defined(KERNEL)
173 u_int32_t unp_refs;
174#else
175 struct unp_head unp_refs; /* referencing socket linked list */
176#endif
177 _UNPCB_LIST_ENTRY(unpcb_compat) unp_reflink; /* link in unp_refs list */
178 _UNPCB_PTR(struct sockaddr_un *) unp_addr; /* bound address of socket */
179 int unp_cc; /* copy of rcv.sb_cc */
180 int unp_mbcnt; /* copy of rcv.sb_mbcnt */
181 unp_gen_t unp_gencnt; /* generation count of this instance */
182};
183
184/* Hack alert -- this structure depends on <sys/socketvar.h>. */
185#ifdef _SYS_SOCKETVAR_H_
186
187#pragma pack(4)
188
189struct xunpcb {
190 u_int32_t xu_len; /* length of this structure */
191 _UNPCB_PTR(struct unpcb_compat *) xu_unpp; /* to help netstat, fstat */
192 struct unpcb_compat xu_unp; /* our information */
193 union {
194 struct sockaddr_un xuu_addr; /* our bound address */
195 char xu_dummy1[256];
196 } xu_au;
197#define xu_addr xu_au.xuu_addr
198 union {
199 struct sockaddr_un xuu_caddr; /* their bound address */
200 char xu_dummy2[256];
201 } xu_cau;
202#define xu_caddr xu_cau.xuu_caddr
203 struct xsocket xu_socket;
204 u_quad_t xu_alignment_hack;
205};
206
207#if !CONFIG_EMBEDDED
208
209struct xunpcb64_list_entry {
210 u_int64_t le_next;
211 u_int64_t le_prev;
212};
213
214struct xunpcb64 {
215 u_int32_t xu_len; /* length of this structure */
216 u_int64_t xu_unpp; /* to help netstat, fstat */
217 struct xunpcb64_list_entry xunp_link; /* glue on list of all PCBs */
218 u_int64_t xunp_socket; /* pointer back to socket */
219 u_int64_t xunp_vnode; /* if associated with file */
220 u_int64_t xunp_ino; /* fake inode number */
221 u_int64_t xunp_conn; /* control block of connected socket */
222 u_int64_t xunp_refs; /* referencing socket linked list */
223 struct xunpcb64_list_entry xunp_reflink; /* link in unp_refs list */
224 int xunp_cc; /* copy of rcv.sb_cc */
225 int xunp_mbcnt; /* copy of rcv.sb_mbcnt */
226 unp_gen_t xunp_gencnt; /* generation count of this instance */
227 int xunp_flags; /* flags */
228 union {
229 struct sockaddr_un xuu_addr;
230 char xu_dummy1[256];
231 } xu_au; /* our bound address */
232#define xunp_addr xu_au.xuu_addr
233 union {
234 struct sockaddr_un xuu_caddr;
235 char xu_dummy2[256];
236 } xu_cau; /* their bound address */
237#define xunp_caddr xu_cau.xuu_caddr
238 struct xsocket64 xu_socket;
239};
240
241#endif /* !CONFIG_EMBEDDED */
242
243#pragma pack()
244
245#endif /* _SYS_SOCKETVAR_H_ */
246
247#endif /* PRIVATE */
248
249struct xunpgen {
250 u_int32_t xug_len;
251 u_int xug_count;
252 unp_gen_t xug_gen;
253 so_gen_t xug_sogen;
254};
255
256#endif /* _SYS_UNPCB_H_ */
257