1/*
2 * Copyright (c) 2008-2020 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#if !KERNEL && PRIVATE
72#include <TargetConditionals.h>
73#endif
74
75/*
76 * Protocol control block for an active
77 * instance of a UNIX internal protocol.
78 *
79 * A socket may be associated with an vnode in the
80 * file system. If so, the unp_vnode pointer holds
81 * a reference count to this vnode, which should be irele'd
82 * when the socket goes away.
83 *
84 * A socket may be connected to another socket, in which
85 * case the control block of the socket to which it is connected
86 * is given by unp_conn.
87 *
88 * A socket may be referenced by a number of sockets (e.g. several
89 * sockets may be connected to a datagram socket.) These sockets
90 * are in a linked list starting with unp_refs, linked through
91 * unp_nextref and null-terminated. Note that a socket may be referenced
92 * by a number of other sockets and may also reference a socket (not
93 * necessarily one which is referencing it). This generates
94 * the need for unp_refs and unp_nextref to be separate fields.
95 *
96 * Stream sockets keep copies of receive sockbuf sb_cc and sb_mbcnt
97 * so that changes in the sockbuf may be computed to modify
98 * back pressure on the sender accordingly.
99 */
100
101typedef u_quad_t unp_gen_t;
102
103#if defined(__LP64__)
104struct _unpcb_list_entry {
105 u_int32_t le_next;
106 u_int32_t le_prev;
107};
108#define _UCPCB_LIST_HEAD(name, type) \
109struct name { \
110 u_int32_t lh_first; \
111};
112#define _UNPCB_LIST_ENTRY(x) struct _unpcb_list_entry
113#define _UNPCB_PTR(x) u_int32_t
114#else
115#define _UCPCB_LIST_HEAD(name, type) LIST_HEAD(name, type)
116#define _UNPCB_LIST_ENTRY(x) LIST_ENTRY(x)
117#define _UNPCB_PTR(x) x
118#endif
119
120#ifdef PRIVATE
121#ifndef KERNEL
122_UCPCB_LIST_HEAD(unp_head, unpcb);
123#else
124LIST_HEAD(unp_head, unpcb);
125#define sotounpcb(so) ((struct unpcb *)((so)->so_pcb))
126
127struct unpcb {
128 LIST_ENTRY(unpcb) unp_link; /* glue on list of all PCBs */
129 struct socket *unp_socket; /* pointer back to socket */
130 struct vnode *unp_vnode; /* if associated with file */
131 ino_t unp_ino; /* fake inode number */
132 struct unpcb *unp_conn; /* control block of connected socket */
133 struct unp_head unp_refs; /* referencing socket linked list */
134 LIST_ENTRY(unpcb) unp_reflink; /* link in unp_refs list */
135 struct sockaddr_un *unp_addr; /* bound address of socket */
136 unp_gen_t unp_gencnt; /* generation count of this instance */
137 int unp_cc; /* copy of rcv.sb_cc */
138 int unp_mbcnt; /* copy of rcv.sb_mbcnt */
139 uint32_t unp_flags; /* flags */
140 uint32_t rw_thrcount; /* disconnect should wait for this count to become zero */
141 struct xucred unp_peercred; /* peer credentials, if applicable */
142 decl_lck_mtx_data(, unp_mtx); /* per unpcb lock */
143};
144#endif /* KERNEL */
145
146/*
147 * Flags in unp_flags.
148 *
149 * UNP_HAVEPC - indicates that the unp_peercred member is filled in
150 * and is really the credentials of the connected peer. This is used
151 * to determine whether the contents should be sent to the user or
152 * not.
153 *
154 * UNP_HAVEPCCACHED - indicates that the unp_peercred member is filled
155 * in, but does *not* contain the credentials of the connected peer
156 * (there may not even be a peer). This is set in unp_listen() when
157 * it fills in unp_peercred for later consumption by unp_connect().
158 */
159#define UNP_HAVEPC 0x00000001
160#define UNP_HAVEPCCACHED 0x00000002
161#define UNP_DONTDISCONNECT 0x00000004
162#define UNP_NOPEERACCEPT 0x00000010
163#define UNP_TRACE_MDNS 0x00001000
164
165#ifdef KERNEL
166struct unpcb_compat {
167#else /* KERNEL */
168#define unpcb_compat unpcb
169struct unpcb {
170#endif /* KERNEL */
171 _UNPCB_LIST_ENTRY(unpcb_compat) unp_link; /* glue on list of all PCBs */
172 _UNPCB_PTR(struct socket *) unp_socket; /* pointer back to socket */
173 _UNPCB_PTR(struct vnode *) unp_vnode; /* if associated with file */
174 u_int32_t unp_ino; /* fake inode number */
175 _UNPCB_PTR(struct unpcb_compat *) unp_conn; /* control block of connected socket */
176#if defined(KERNEL)
177 u_int32_t unp_refs;
178#else
179 struct unp_head unp_refs; /* referencing socket linked list */
180#endif
181 _UNPCB_LIST_ENTRY(unpcb_compat) unp_reflink; /* link in unp_refs list */
182 _UNPCB_PTR(struct sockaddr_un *) unp_addr; /* bound address of socket */
183 int unp_cc; /* copy of rcv.sb_cc */
184 int unp_mbcnt; /* copy of rcv.sb_mbcnt */
185 unp_gen_t unp_gencnt; /* generation count of this instance */
186};
187
188/* Hack alert -- this structure depends on <sys/socketvar.h>. */
189#ifdef _SYS_SOCKETVAR_H_
190
191#pragma pack(4)
192
193struct xunpcb {
194 u_int32_t xu_len; /* length of this structure */
195 _UNPCB_PTR(struct unpcb_compat *) xu_unpp; /* to help netstat, fstat */
196 struct unpcb_compat xu_unp; /* our information */
197 union {
198 struct sockaddr_un xuu_addr; /* our bound address */
199 char xu_dummy1[256];
200 } xu_au;
201#define xu_addr xu_au.xuu_addr
202 union {
203 struct sockaddr_un xuu_caddr; /* their bound address */
204 char xu_dummy2[256];
205 } xu_cau;
206#define xu_caddr xu_cau.xuu_caddr
207 struct xsocket xu_socket;
208 u_quad_t xu_alignment_hack;
209};
210
211#if XNU_TARGET_OS_OSX || KERNEL || !(TARGET_OS_IPHONE && !TARGET_OS_SIMULATOR)
212
213struct xunpcb64_list_entry {
214 u_int64_t le_next;
215 u_int64_t le_prev;
216};
217
218struct xunpcb64 {
219 u_int32_t xu_len; /* length of this structure */
220 u_int64_t xu_unpp; /* to help netstat, fstat */
221 struct xunpcb64_list_entry xunp_link; /* glue on list of all PCBs */
222 u_int64_t xunp_socket; /* pointer back to socket */
223 u_int64_t xunp_vnode; /* if associated with file */
224 u_int64_t xunp_ino; /* fake inode number */
225 u_int64_t xunp_conn; /* control block of connected socket */
226 u_int64_t xunp_refs; /* referencing socket linked list */
227 struct xunpcb64_list_entry xunp_reflink; /* link in unp_refs list */
228 int xunp_cc; /* copy of rcv.sb_cc */
229 int xunp_mbcnt; /* copy of rcv.sb_mbcnt */
230 unp_gen_t xunp_gencnt; /* generation count of this instance */
231 int xunp_flags; /* flags */
232 union {
233 struct sockaddr_un xuu_addr;
234 char xu_dummy1[256];
235 } xu_au; /* our bound address */
236#define xunp_addr xu_au.xuu_addr
237 union {
238 struct sockaddr_un xuu_caddr;
239 char xu_dummy2[256];
240 } xu_cau; /* their bound address */
241#define xunp_caddr xu_cau.xuu_caddr
242 struct xsocket64 xu_socket;
243};
244
245#endif /* XNU_TARGET_OS_OSX || KERNEL || !(TARGET_OS_IPHONE && !TARGET_OS_SIMULATOR) */
246
247struct xunpcb_n {
248 u_int32_t xunp_len; /* length of this structure */
249 u_int32_t xunp_kind; /* XSO_UNPCB */
250 u_int64_t xunp_unpp; /* to help netstat, fstat */
251 u_int64_t xunp_vnode; /* if associated with file */
252 u_int64_t xunp_ino; /* fake inode number */
253 u_int64_t xunp_conn; /* control block of connected socket */
254 u_int64_t xunp_refs; /* referencing socket linked list */
255 u_int64_t xunp_reflink; /* link in unp_refs list */
256 int xunp_cc; /* copy of rcv.sb_cc */
257 int xunp_mbcnt; /* copy of rcv.sb_mbcnt */
258 int xunp_flags; /* flags */
259 unp_gen_t xunp_gencnt; /* generation count of this instance */
260 union {
261 struct sockaddr_un xuu_addr; /* our bound address */
262 char xu_dummy1[256];
263 } xu_au;
264#define xu_addr xu_au.xuu_addr
265 union {
266 struct sockaddr_un xuu_caddr; /* their bound address */
267 char xu_dummy2[256];
268 } xu_cau;
269#define xu_caddr xu_cau.xuu_caddr
270};
271
272#pragma pack()
273
274#endif /* _SYS_SOCKETVAR_H_ */
275
276#endif /* PRIVATE */
277
278struct xunpgen {
279 u_int32_t xug_len;
280 u_int xug_count;
281 unp_gen_t xug_gen;
282 so_gen_t xug_sogen;
283};
284
285#endif /* _SYS_UNPCB_H_ */
286