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 Software.Distribution@CS.CMU.EDU |
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 | /* |
80 | * Initial sub-structure in common with all ipc_objects. |
81 | */ |
82 | struct ipc_object ips_object; |
83 | struct ipc_mqueue ips_messages; |
84 | }; |
85 | |
86 | #define ips_references ips_object.io_references |
87 | |
88 | #define ips_active(pset) io_active(&(pset)->ips_object) |
89 | #define ips_lock(pset) io_lock(&(pset)->ips_object) |
90 | #define ips_lock_try(pset) io_lock_try(&(pset)->ips_object) |
91 | #define ips_lock_held_kdp(pset) io_lock_held_kdp(&(pset)->ips_object) |
92 | #define ips_unlock(pset) io_unlock(&(pset)->ips_object) |
93 | #define ips_reference(pset) io_reference(&(pset)->ips_object) |
94 | #define ips_release(pset) io_release(&(pset)->ips_object) |
95 | |
96 | /* get an ipc_pset pointer from an ipc_mqueue pointer */ |
97 | #define ips_from_mq(mq) \ |
98 | __container_of(mq, struct ipc_pset, ips_messages) |
99 | |
100 | /* Allocate a port set */ |
101 | extern kern_return_t ipc_pset_alloc( |
102 | ipc_space_t space, |
103 | mach_port_name_t *namep, |
104 | ipc_pset_t *psetp); |
105 | |
106 | /* Allocate a port set, with a specific name */ |
107 | extern kern_return_t ipc_pset_alloc_name( |
108 | ipc_space_t space, |
109 | mach_port_name_t name, |
110 | ipc_pset_t *psetp); |
111 | |
112 | /* Allocate a port set in a special space */ |
113 | extern ipc_pset_t ipc_pset_alloc_special( |
114 | ipc_space_t space); |
115 | |
116 | /* Add a port to a port set */ |
117 | extern kern_return_t ipc_pset_add( |
118 | ipc_pset_t pset, |
119 | ipc_port_t port, |
120 | uint64_t *reserved_link, |
121 | uint64_t *reserved_prepost); |
122 | |
123 | /* determine if port is a member of set */ |
124 | extern boolean_t ipc_pset_member( |
125 | ipc_pset_t pset, |
126 | ipc_port_t port); |
127 | |
128 | /* Remove a port from a port set */ |
129 | extern kern_return_t ipc_pset_remove( |
130 | ipc_pset_t pset, |
131 | ipc_port_t port); |
132 | |
133 | /* lazily initialize the wqset of a port set */ |
134 | extern kern_return_t ipc_pset_lazy_allocate( |
135 | ipc_space_t space, |
136 | mach_port_name_t psname); |
137 | |
138 | /* Remove a port from all its current port sets */ |
139 | extern kern_return_t ipc_pset_remove_from_all( |
140 | ipc_port_t port); |
141 | |
142 | /* Destroy a port_set */ |
143 | extern void ipc_pset_destroy( |
144 | ipc_pset_t pset); |
145 | |
146 | #if MACH_KERNEL_PRIVATE |
147 | extern struct turnstile *filt_machport_kqueue_turnstile( |
148 | struct knote *kn); |
149 | |
150 | extern struct turnstile *filt_machport_stashed_special_reply_port_turnstile( |
151 | ipc_port_t port); |
152 | |
153 | extern void filt_machport_turnstile_prepare_lazily( |
154 | struct knote *kn, |
155 | mach_msg_type_name_t msgt_name, |
156 | ipc_port_t port); |
157 | |
158 | extern struct turnstile *filt_machport_stash_port( |
159 | struct knote *kn, |
160 | ipc_port_t port, |
161 | int *link); |
162 | #endif |
163 | |
164 | #endif /* _IPC_IPC_PSET_H_ */ |
165 | |