1 /*
2 * Copyright (c) 2000-2004 Apple Computer, 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 * @OSF_COPYRIGHT@
30 */
31 /*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 * Software Distribution Coordinator or [email protected]
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56 /*
57 */
58 /*
59 * File: ipc/ipc_pset.h
60 * Author: Rich Draves
61 * Date: 1989
62 *
63 * Definitions for port sets.
64 */
65
66 #ifndef _IPC_IPC_PSET_H_
67 #define _IPC_IPC_PSET_H_
68
69 #include <mach/mach_types.h>
70 #include <mach/port.h>
71 #include <mach/kern_return.h>
72 #include <kern/kern_types.h>
73 #include <ipc/ipc_types.h>
74 #include <ipc/ipc_object.h>
75 #include <ipc/ipc_mqueue.h>
76
77 struct ipc_pset {
78 /*
79 * Initial sub-structure in common with all ipc_objects.
80 */
81 struct ipc_object ips_object;
82 struct waitq_set ips_wqset;
83 struct klist ips_klist;
84 };
85
86 #define ips_object_to_pset(io) __container_of(io, struct ipc_pset, ips_object)
87 #define ips_to_object(pset) (&(pset)->ips_object)
88
89 static inline ipc_pset_t
ips_from_waitq(waitq_t wq)90 ips_from_waitq(waitq_t wq)
91 {
92 return __container_of(wq.wqs_set, struct ipc_pset, ips_wqset);
93 }
94
95 #define ips_active(pset) io_active(ips_to_object(pset))
96 #define ips_mq_lock_held(pset) io_lock_held(ips_to_object(pset))
97 #define ips_mq_lock(pset) ipc_object_lock(ips_to_object(pset), IOT_PORT_SET)
98 #define ips_mq_lock_held_kdp(pset) io_lock_held_kdp(ips_to_object(pset))
99 #define ips_mq_unlock(pset) io_unlock(ips_to_object(pset))
100 #define ips_reference(pset) io_reference(ips_to_object(pset))
101 #define ips_release(pset) io_release(ips_to_object(pset))
102 #define ips_validate(pset) \
103 zone_id_require(ZONE_ID_IPC_PORT_SET, sizeof(struct ipc_pset), pset)
104 #define ips_validate_aligned(pset) \
105 zone_id_require_aligned(ZONE_ID_IPC_PORT_SET, pset)
106
107 /* Allocate a port set */
108 extern kern_return_t ipc_pset_alloc(
109 ipc_space_t space,
110 mach_port_name_t *namep,
111 ipc_pset_t *psetp);
112
113 /* Allocate a port set, with a specific name */
114 extern kern_return_t ipc_pset_alloc_name(
115 ipc_space_t space,
116 mach_port_name_t name,
117 ipc_pset_t *psetp);
118
119 /* Allocate a port set in a special space */
120 extern ipc_pset_t ipc_pset_alloc_special(
121 ipc_space_t space);
122
123 /* Destroy a port_set */
124 extern void ipc_pset_destroy(
125 ipc_space_t space,
126 ipc_pset_t pset);
127
128 /* Finalize the destruction of a pset before it gets freed */
129 extern void ipc_pset_finalize(
130 ipc_pset_t pset);
131
132 #if MACH_KERNEL_PRIVATE
133 extern struct turnstile *filt_ipc_kqueue_turnstile(
134 struct knote *kn);
135
136 extern bool filt_machport_kqueue_has_turnstile(
137 struct knote *kn);
138
139 extern void filt_machport_turnstile_prepare_lazily(
140 struct knote *kn,
141 mach_msg_type_name_t msgt_name,
142 ipc_port_t port);
143
144 extern struct turnstile *filt_machport_stash_port(
145 struct knote *kn,
146 ipc_port_t port,
147 int *link);
148 #endif
149
150 #endif /* _IPC_IPC_PSET_H_ */
151