1 /*
2 * Copyright (c) 2000-2016 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 * NOTICE: This file was modified by McAfee Research in 2004 to introduce
58 * support for mandatory and extensible security protections. This notice
59 * is included in support of clause 2.2 (b) of the Apple Public License,
60 * Version 2.0.
61 */
62 /*
63 */
64 /*
65 * File: ipc/ipc_port.h
66 * Author: Rich Draves
67 * Date: 1989
68 *
69 * Definitions for ports.
70 */
71
72 #ifndef _IPC_IPC_PORT_H_
73 #define _IPC_IPC_PORT_H_
74
75 #ifdef MACH_KERNEL_PRIVATE
76
77 #include <mach_assert.h>
78
79 #include <mach/mach_types.h>
80 #include <mach/boolean.h>
81 #include <mach/kern_return.h>
82 #include <mach/port.h>
83
84 #include <kern/assert.h>
85 #include <kern/kern_types.h>
86 #include <kern/turnstile.h>
87
88 #include <ipc/ipc_types.h>
89 #include <ipc/ipc_object.h>
90 #include <ipc/ipc_mqueue.h>
91 #include <ipc/ipc_space.h>
92
93 #include <security/_label.h>
94
95 #include <ptrauth.h>
96
97 extern int proc_isinitproc(struct proc *p);
98
99 struct task_watchport_elem;
100
101 typedef unsigned int ipc_port_timestamp_t;
102
103 struct ipc_port_request {
104 union {
105 struct ipc_port *ipr_soright;
106 struct host_notify_entry *XNU_PTRAUTH_SIGNED_PTR("ipc_port_request.ipr_hnotify") ipr_hnotify;
107 struct ipc_port_request *XNU_PTRAUTH_SIGNED_PTR("ipc_port_request.ipr_hn_slot") ipr_hn_slot;
108 };
109
110 union {
111 #define IPR_HOST_NOTIFY 0xfffffffeu
112 mach_port_name_t ipr_name;
113 ipc_port_request_index_t ipr_next;
114 };
115 };
116
117 KALLOC_ARRAY_TYPE_DECL(ipc_port_request_table, struct ipc_port_request);
118
119 struct ipc_port {
120 struct ipc_object ip_object;
121 union {
122 /*
123 * The waitq_eventmask field is only used on the global queues.
124 * We hence repurpose all those bits for our own use.
125 *
126 * Note: if too many bits are added, compilation will fail
127 * with errors about "negative bitfield sizes"
128 */
129 WAITQ_FLAGS(ip_waitq
130 , ip_fullwaiters:1 /* Whether there are senders blocked on a full queue */
131 , ip_sprequests:1 /* send-possible requests outstanding */
132 , ip_spimportant:1 /* ... at least one is importance donating */
133 , ip_impdonation:1 /* port supports importance donation */
134 , ip_tempowner:1 /* dont give donations to current receiver */
135 , ip_guarded:1 /* port guarded (use context value as guard) */
136 , ip_strict_guard:1 /* Strict guarding; Prevents user manipulation of context values directly */
137 , ip_specialreply:1 /* port is a special reply port */
138 , ip_sync_link_state:3 /* link the port to destination port/ Workloop */
139 , ip_sync_bootstrap_checkin:1 /* port part of sync bootstrap checkin, push on thread doing the checkin */
140 , ip_immovable_receive:1 /* the receive right cannot be moved out of a space, until it is destroyed */
141 , ip_immovable_send:1 /* No send(once) rights to this port can be moved out of a space, never unset */
142 , ip_no_grant:1 /* Port wont accept complex messages containing (ool) port descriptors */
143 , ip_tg_block_tracking:1 /* Track blocking relationship between thread groups during sync IPC */
144 , ip_pinned:1 /* Can't deallocate the last send right from a space while the bit is set */
145 , ip_service_port:1 /* port is a service port */
146 , ip_has_watchport:1 /* port has an exec watchport */
147 , ip_kernel_iotier_override:2 /* kernel iotier override */
148 , ip_kernel_qos_override:3 /* kernel qos override */
149 , ip_reply_port_semantics:3 /* reply port defense in depth type */
150 );
151 struct waitq ip_waitq;
152 };
153
154 struct ipc_mqueue ip_messages;
155
156 /*
157 * IMPORTANT: Direct access of unionized fields are highly discouraged.
158 * Use accessor functions below and see header doc for possible states.
159 */
160 union {
161 struct ipc_space *XNU_PTRAUTH_SIGNED_PTR("ipc_port.ip_receiver") ip_receiver;
162 struct ipc_port *XNU_PTRAUTH_SIGNED_PTR("ipc_port.ip_destination") ip_destination;
163 ipc_port_timestamp_t ip_timestamp;
164 };
165
166 /* update ipc_kobject_upgrade_locked() if this union is changed */
167 union {
168 uintptr_t ip_kobject; /* manually PAC-ed, see ipc_kobject_get_raw() */
169 ipc_importance_task_t ip_imp_task; /* use accessor ip_get_imp_task() */
170 struct ipc_port *ip_sync_inheritor_port;
171 struct knote *ip_sync_inheritor_knote;
172 struct turnstile *ip_sync_inheritor_ts;
173 };
174
175 /*
176 * ip_specialreply: ip_pid
177 * ip_has_watchport: ip_twe
178 * else: ip_pdrequest
179 */
180 union {
181 int ip_pid;
182 struct task_watchport_elem *XNU_PTRAUTH_SIGNED_PTR("ipc_port.ip_twe") ip_twe;
183 struct ipc_port *XNU_PTRAUTH_SIGNED_PTR("ipc_port.ip_pdrequest") ip_pdrequest;
184 };
185
186 #define IP_KOBJECT_NSREQUEST_ARMED ((struct ipc_port *)1)
187 struct ipc_port *ip_nsrequest;
188 ipc_port_request_table_t XNU_PTRAUTH_SIGNED_PTR("ipc_port.ip_request") ip_requests;
189 struct turnstile *ip_send_turnstile;
190 mach_vm_address_t ip_context;
191
192 #if DEVELOPMENT || DEBUG
193 natural_t ip_srp_lost_link : 1; /* special reply port turnstile link chain broken */
194 natural_t ip_srp_msg_sent : 1; /* special reply port msg sent */
195 natural_t ip_impcount : 30; /* number of importance donations in nested queue */
196 #else
197 natural_t ip_impcount; /* number of importance donations in nested queue */
198 #endif
199 mach_port_mscount_t ip_mscount;
200 mach_port_rights_t ip_srights;
201 mach_port_rights_t ip_sorights;
202
203 union {
204 ipc_kobject_label_t XNU_PTRAUTH_SIGNED_PTR("ipc_port.kolabel") ip_kolabel;
205 /* Union of service and connection ports' message filtering metadata */
206 void * XNU_PTRAUTH_SIGNED_PTR("ipc_port.ip_splabel") ip_splabel;
207 };
208
209 #if MACH_ASSERT
210 unsigned long ip_timetrack; /* give an idea of "when" created */
211 uint32_t ip_made_bt; /* stack trace (btref_t) */
212 uint32_t ip_made_pid; /* for debugging */
213 #endif /* MACH_ASSERT */
214 };
215
216 static inline bool
ip_in_pset(ipc_port_t port)217 ip_in_pset(ipc_port_t port)
218 {
219 return !circle_queue_empty(&port->ip_waitq.waitq_links);
220 }
221
222 #define ip_receiver_name ip_messages.imq_receiver_name
223 #define ip_reply_context ip_messages.imq_context
224 #define ip_klist ip_messages.imq_klist
225
226 #define port_send_turnstile(port) \
227 ((port)->ip_send_turnstile)
228
229 #define set_port_send_turnstile(port, value) \
230 MACRO_BEGIN \
231 (port)->ip_send_turnstile = (value); \
232 MACRO_END
233
234 #define port_send_turnstile_address(port) \
235 (&((port)->ip_send_turnstile))
236
237 #define port_rcv_turnstile_address(port) (&(port)->ip_waitq.waitq_ts)
238
239 extern void __ipc_right_delta_overflow_panic(
240 ipc_port_t port,
241 natural_t *field,
242 int delta) __abortlike;
243
244 #define ip_right_delta(port, field, delta) ({ \
245 ipc_port_t __port = (port); \
246 if (os_add_overflow(__port->field, delta, &__port->field)) { \
247 __ipc_right_delta_overflow_panic(__port, &__port->field, delta); \
248 } \
249 })
250
251 #define ip_srights_inc(port) ip_right_delta(port, ip_srights, 1)
252 #define ip_srights_dec(port) ip_right_delta(port, ip_srights, -1)
253 #define ip_sorights_inc(port) ip_right_delta(port, ip_sorights, 1)
254 #define ip_sorights_dec(port) ip_right_delta(port, ip_sorights, -1)
255
256 /*
257 * SYNC IPC state flags for special reply port/ rcv right.
258 *
259 * PORT_SYNC_LINK_ANY
260 * Special reply port is not linked to any other port
261 * or WL and linkage should be allowed.
262 *
263 * PORT_SYNC_LINK_PORT
264 * Special reply port is linked to the port and
265 * ip_sync_inheritor_port contains the inheritor
266 * port.
267 *
268 * PORT_SYNC_LINK_WORKLOOP_KNOTE
269 * Special reply port is linked to a WL (via a knote).
270 * ip_sync_inheritor_knote contains a pointer to the knote
271 * the port is stashed on.
272 *
273 * PORT_SYNC_LINK_WORKLOOP_STASH
274 * Special reply port is linked to a WL (via a knote stash).
275 * ip_sync_inheritor_ts contains a pointer to the turnstile with a +1
276 * the port is stashed on.
277 *
278 * PORT_SYNC_LINK_NO_LINKAGE
279 * Message sent to special reply port, do
280 * not allow any linkages till receive is
281 * complete.
282 *
283 * PORT_SYNC_LINK_RCV_THREAD
284 * Receive right copied out as a part of bootstrap check in,
285 * push on the thread which copied out the port.
286 */
287 #define PORT_SYNC_LINK_ANY (0)
288 #define PORT_SYNC_LINK_PORT (0x1)
289 #define PORT_SYNC_LINK_WORKLOOP_KNOTE (0x2)
290 #define PORT_SYNC_LINK_WORKLOOP_STASH (0x3)
291 #define PORT_SYNC_LINK_NO_LINKAGE (0x4)
292 #define PORT_SYNC_LINK_RCV_THREAD (0x5)
293
294 #define IP_NULL IPC_PORT_NULL
295 #define IP_DEAD IPC_PORT_DEAD
296 #define IP_VALID(port) IPC_PORT_VALID(port)
297
298 #define ip_object_to_port(io) __container_of(io, struct ipc_port, ip_object)
299 #define ip_to_object(port) (&(port)->ip_object)
300 #define ip_active(port) io_active(ip_to_object(port))
301 #define ip_mq_lock_held(port) io_lock_held(ip_to_object(port))
302 #define ip_mq_lock(port) ipc_object_lock(ip_to_object(port), IOT_PORT)
303 #define ip_mq_lock_check_aligned(port) ipc_object_lock_check_aligned(ip_to_object(port), IOT_PORT)
304 #define ip_mq_lock_try(port) ipc_object_lock_try(ip_to_object(port), IOT_PORT)
305 #define ip_mq_lock_held_kdp(port) io_lock_held_kdp(ip_to_object(port))
306 #define ip_mq_unlock(port) io_unlock(ip_to_object(port))
307
308 #define ip_reference(port) io_reference(ip_to_object(port))
309 #define ip_release(port) io_release(ip_to_object(port))
310 #define ip_release_safe(port) io_release_safe(ip_to_object(port))
311 #define ip_release_live(port) io_release_live(ip_to_object(port))
312 #define ip_validate(port) \
313 zone_id_require(ZONE_ID_IPC_PORT, sizeof(struct ipc_port), port)
314 #define ip_validate_aligned(port) \
315 zone_id_require_aligned(ZONE_ID_IPC_PORT, port)
316
317 #define ip_from_waitq(wq) __container_of(wq, struct ipc_port, ip_waitq)
318 #define ip_from_mq(mq) __container_of(mq, struct ipc_port, ip_messages)
319
320 #define ip_kotype(port) io_kotype(ip_to_object(port))
321 #define ip_is_kobject(port) io_is_kobject(ip_to_object(port))
322 #define ip_is_control(port) \
323 (ip_kotype(port) == IKOT_TASK_CONTROL || ip_kotype(port) == IKOT_THREAD_CONTROL)
324 #define ip_is_kolabeled(port) io_is_kolabeled(ip_to_object(port))
325
326 #define ip_full_kernel(port) imq_full_kernel(&(port)->ip_messages)
327 #define ip_full(port) imq_full(&(port)->ip_messages)
328
329 /*
330 * IPC Port flags for reply port defense in depth
331 *
332 * PORT_MARK_REPLY_PORT
333 * Port is marked as a reply port.
334 *
335 * PORT_ENFORCE_REPLY_PORT_SEMANTICS
336 * When talking to this port, the local port of mach msg needs to be a reply port.
337 * Currrently service ports and libxpc connection ports adopt this.
338 *
339 * PORT_MARK_PROVISIONAL_REPLY_PORT
340 * Port is marked as a provisional reply port with an eventual goal of making it port as PORT_MARK_REPLY_PORT.
341 *
342 * PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS
343 * Same as PORT_ENFORCE_REPLY_PORT_SEMANTICS above, but does not allow for provisional reply ports.
344 * Once provisional reply ports no longer exist, this will be removed as "rigidness/strictness" will be irrelavant.
345 *
346 * PORT_ID_PROTECTED_OPT_OUT
347 * Port is opted out from identity protected enforcement for mach exceptions.
348 */
349 #define PORT_MARK_REPLY_PORT 0x01
350 #define PORT_ENFORCE_REPLY_PORT_SEMANTICS 0x02
351 #define PORT_MARK_PROVISIONAL_REPLY_PORT 0x03
352 #define PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS 0x04
353 #define PORT_ID_PROTECTED_OPT_OUT 0x05
354
355 /* ip_reply_port_semantics can be read without a lock as it is never unset after port creation. */
356 #define ip_is_reply_port(port) (((port)->ip_reply_port_semantics) == PORT_MARK_REPLY_PORT)
357 #define ip_require_reply_port_semantics(port) (((port)->ip_reply_port_semantics) == PORT_ENFORCE_REPLY_PORT_SEMANTICS)
358 #define ip_is_provisional_reply_port(port) (((port)->ip_reply_port_semantics) == PORT_MARK_PROVISIONAL_REPLY_PORT)
359 #define ip_require_rigid_reply_port_semantics(port) (((port)->ip_reply_port_semantics) == PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS)
360 #define ip_is_id_prot_opted_out(port) (((port)->ip_reply_port_semantics) == PORT_ID_PROTECTED_OPT_OUT)
361
362 #define ip_mark_reply_port(port) ((port)->ip_reply_port_semantics = PORT_MARK_REPLY_PORT)
363 #define ip_enforce_reply_port_semantics(port) ((port)->ip_reply_port_semantics = PORT_ENFORCE_REPLY_PORT_SEMANTICS)
364 #define ip_mark_provisional_reply_port(port) ((port)->ip_reply_port_semantics = PORT_MARK_PROVISIONAL_REPLY_PORT)
365 #define ip_enforce_rigid_reply_port_semantics(port) ((port)->ip_reply_port_semantics = PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS)
366 #define ip_mark_id_prot_opt_out(port) ((port)->ip_reply_port_semantics = PORT_ID_PROTECTED_OPT_OUT)
367
368 #define ip_is_immovable_send(port) ((port)->ip_immovable_send)
369 #define ip_is_pinned(port) ((port)->ip_pinned)
370
371 #define ip_is_libxpc_connection_port(port) \
372 (!ip_is_kolabeled(port) && (!(port)->ip_service_port) && ((port)->ip_splabel != NULL))
373
374 extern bool ip_violates_rigid_reply_port_semantics(ipc_port_t dest_port, ipc_port_t reply_port,
375 int *reply_port_semantics_violation);
376
377 extern bool ip_violates_reply_port_semantics(ipc_port_t dest_port, ipc_port_t reply_port,
378 int *reply_port_semantics_violation);
379
380 /* Rigid Reply Port and Move Reply Port violators */
381 #define REPLY_PORT_SEMANTICS_VIOLATOR 1 /* normal reply port semantics violator */
382 #define RRP_HARDENED_RUNTIME_VIOLATOR 2
383 #define MRP_HARDENED_RUNTIME_VIOLATOR 3
384 #define MRP_3P_VIOLATOR 4
385 #define RRP_3P_VIOLATOR 5
386
387 /* Bits reserved in IO_BITS_PORT_INFO are defined here */
388
389 /*
390 * This flag indicates that the port has opted into message filtering based
391 * on a policy defined in the Sandbox.
392 */
393 #define IP_BIT_FILTER_MSG 0x00001000
394 #define ip_enforce_msg_filtering(port) ((io_bits(ip_to_object(port)) & IP_BIT_FILTER_MSG) != 0)
395
396 /*
397 * Use the low bits in the ipr_soright to specify the request type
398 */
399 __enum_decl(ipc_port_request_opts_t, uintptr_t, {
400 IPR_SOR_SPARM_MASK = 0x01, /* send-possible armed */
401 IPR_SOR_SPREQ_MASK = 0x02, /* send-possible requested */
402 });
403 #define IPR_SOR_SPBIT_MASK 3 /* combo */
404 #define IPR_SOR_SPARMED(sor) (((uintptr_t)(sor) & IPR_SOR_SPARM_MASK) != 0)
405 #define IPR_SOR_SPREQ(sor) (((uintptr_t)(sor) & IPR_SOR_SPREQ_MASK) != 0)
406 #define IPR_SOR_PORT(sor) ((ipc_port_t)((uintptr_t)(sor) & ~IPR_SOR_SPBIT_MASK))
407 #define IPR_SOR_MAKE(p, m) ((ipc_port_t)((uintptr_t)(p) | (m)))
408
409 extern lck_grp_t ipc_lck_grp;
410 extern lck_attr_t ipc_lck_attr;
411
412 /*
413 * Taking the ipc_port_multiple lock grants the privilege
414 * to lock multiple ports at once. No ports must locked
415 * when it is taken.
416 */
417
418 extern lck_spin_t ipc_port_multiple_lock_data;
419
420 #define ipc_port_multiple_lock() \
421 lck_spin_lock_grp(&ipc_port_multiple_lock_data, &ipc_lck_grp)
422
423 #define ipc_port_multiple_unlock() \
424 lck_spin_unlock(&ipc_port_multiple_lock_data)
425
426 /*
427 * Search for the end of the chain (a port not in transit),
428 * acquiring locks along the way.
429 */
430 extern boolean_t ipc_port_destination_chain_lock(
431 ipc_port_t port,
432 ipc_port_t *base);
433
434 /*
435 * The port timestamp facility provides timestamps
436 * for port destruction. It is used to serialize
437 * mach_port_names with port death.
438 */
439
440 extern ipc_port_timestamp_t ipc_port_timestamp_data;
441
442 /* Retrieve a port timestamp value */
443 extern ipc_port_timestamp_t ipc_port_timestamp(void);
444
445 /*
446 * Compares two timestamps, and returns TRUE if one
447 * happened before two. Note that this formulation
448 * works when the timestamp wraps around at 2^32,
449 * as long as one and two aren't too far apart.
450 */
451
452 #define IP_TIMESTAMP_ORDER(one, two) ((int) ((one) - (two)) < 0)
453
454 extern void __abortlike __ipc_port_inactive_panic(ipc_port_t port);
455
456 static inline void
require_ip_active(ipc_port_t port)457 require_ip_active(ipc_port_t port)
458 {
459 if (!ip_active(port)) {
460 __ipc_port_inactive_panic(port);
461 }
462 }
463
464 /*
465 * A receive right (port) can be in ONE of the following four states:
466 *
467 * 1) INACTIVE: Dead
468 * 2) IN-SPACE: In a space
469 * 3) IN-TRANSIT: Enqueued in a message
470 * 4) IN-LIMBO
471 *
472 * If the port is active and ip_receiver_name != MACH_PORT_NULL, we can safely
473 * deference the union as ip_receiver, which points to the space that holds
474 * receive right (but doesn't hold a ref for it).
475 *
476 * If the port is active and ip_receiver_name == MACH_PORT_NULL, we can safely
477 * deference the union as ip_destination. The port is either IN-LIMBO (ip_destination == IP_NULL)
478 * or ip_destination points to the destination port and holds a ref for it.
479 *
480 * If the port is not active, we can safely deference the union as ip_timestamp,
481 * which contains a timestamp taken when the port was destroyed.
482 *
483 * If the port is in a space, ip_receiver_name denotes the port name its receive
484 * right occupies in the receiving space. The only exception, as an optimization trick,
485 * is task's self port (itk_self), whose ip_receiver_name actually denotes the name
486 * of mach_task_self() in owning task's space (a send right, with receive right in ipc_space_kernel).
487 */
488
489 static inline bool
ip_in_a_space(ipc_port_t port)490 ip_in_a_space(ipc_port_t port)
491 {
492 /* IN-SPACE */
493 return ip_active(port) && port->ip_receiver_name != MACH_PORT_NULL;
494 }
495
496 static inline bool
ip_in_space(ipc_port_t port,ipc_space_t space)497 ip_in_space(ipc_port_t port, ipc_space_t space)
498 {
499 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
500 return ip_in_a_space(port) && port->ip_receiver == space;
501 }
502
503 /* use sparsely when port lock is not possible, just compare raw pointer */
504 static inline bool
ip_in_space_noauth(ipc_port_t port,void * space)505 ip_in_space_noauth(ipc_port_t port, void* space)
506 {
507 void *__single raw_ptr = ptrauth_strip(*(void **)&port->ip_receiver, ptrauth_key_process_independent_data);
508 return raw_ptr == space;
509 }
510
511 static inline bool
ip_in_transit(ipc_port_t port)512 ip_in_transit(ipc_port_t port)
513 {
514 /* IN-TRANSIT */
515 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
516 return ip_active(port) && !ip_in_a_space(port) && port->ip_destination != IP_NULL;
517 }
518
519 static inline bool
ip_in_limbo(ipc_port_t port)520 ip_in_limbo(ipc_port_t port)
521 {
522 /* IN-LIMBO */
523 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
524 return ip_active(port) && !ip_in_a_space(port) && port->ip_destination == IP_NULL;
525 }
526
527 static inline ipc_space_t
ip_get_receiver(ipc_port_t port)528 ip_get_receiver(ipc_port_t port)
529 {
530 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
531 return ip_in_a_space(port) ? port->ip_receiver : NULL;
532 }
533
534 static inline void*
ip_get_receiver_ptr_noauth(ipc_port_t port)535 ip_get_receiver_ptr_noauth(ipc_port_t port)
536 {
537 void *__single raw_ptr = ptrauth_strip(*(void **)&port->ip_receiver, ptrauth_key_process_independent_data);
538 return raw_ptr;
539 }
540
541 static inline mach_port_name_t
ip_get_receiver_name(ipc_port_t port)542 ip_get_receiver_name(ipc_port_t port)
543 {
544 return ip_in_a_space(port) ? port->ip_receiver_name : MACH_PORT_NULL;
545 }
546
547 static inline ipc_port_t
ip_get_destination(ipc_port_t port)548 ip_get_destination(ipc_port_t port)
549 {
550 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
551 return ip_active(port) && !ip_in_a_space(port) ? port->ip_destination : IP_NULL;
552 }
553
554 static inline ipc_port_timestamp_t
ip_get_death_time(ipc_port_t port)555 ip_get_death_time(ipc_port_t port)
556 {
557 assert(!ip_active(port));
558 return port->ip_timestamp;
559 }
560
561 static inline ipc_importance_task_t
ip_get_imp_task(ipc_port_t port)562 ip_get_imp_task(ipc_port_t port)
563 {
564 return (!ip_is_kobject(port) && !port->ip_specialreply && port->ip_tempowner) ? port->ip_imp_task : IIT_NULL;
565 }
566
567 extern kern_return_t ipc_port_translate_send(
568 ipc_space_t space,
569 mach_port_name_t name,
570 ipc_port_t *portp);
571
572 extern kern_return_t ipc_port_translate_receive(
573 ipc_space_t space,
574 mach_port_name_t name,
575 ipc_port_t *portp);
576
577 /* Allocate a notification request slot */
578 extern kern_return_t ipc_port_request_alloc(
579 ipc_port_t port,
580 mach_port_name_t name,
581 ipc_port_t soright,
582 ipc_port_request_opts_t options,
583 ipc_port_request_index_t *indexp);
584
585 extern kern_return_t ipc_port_request_hnotify_alloc(
586 ipc_port_t port,
587 struct host_notify_entry *hnotify,
588 ipc_port_request_index_t *indexp);
589
590 /* Grow one of a port's tables of notifcation requests */
591 extern kern_return_t ipc_port_request_grow(
592 ipc_port_t port);
593
594 /* Return the type(s) of notification requests outstanding */
595 extern mach_port_type_t ipc_port_request_type(
596 ipc_port_t port,
597 mach_port_name_t name,
598 ipc_port_request_index_t index);
599
600 /* Cancel a notification request and return the send-once right */
601 extern ipc_port_t ipc_port_request_cancel(
602 ipc_port_t port,
603 mach_port_name_t name,
604 ipc_port_request_index_t index);
605
606 /* Arm any delayed send-possible notification */
607 extern boolean_t ipc_port_request_sparm(
608 ipc_port_t port,
609 mach_port_name_t name,
610 ipc_port_request_index_t index,
611 mach_msg_option64_t option,
612 mach_msg_priority_t priority);
613
614 /* Make a no-senders request */
615 extern void ipc_port_nsrequest(
616 ipc_port_t port,
617 mach_port_mscount_t sync,
618 ipc_port_t notify,
619 ipc_port_t *previousp);
620
621 /* Prepare a receive right for transmission/destruction */
622 extern boolean_t ipc_port_clear_receiver(
623 ipc_port_t port,
624 boolean_t should_destroy,
625 waitq_link_list_t *free_l);
626
627 __options_decl(ipc_port_init_flags_t, uint32_t, {
628 IPC_PORT_INIT_NONE = 0x00000000,
629 IPC_PORT_INIT_MAKE_SEND_RIGHT = 0x00000001,
630 IPC_PORT_INIT_MESSAGE_QUEUE = 0x00000002,
631 IPC_PORT_INIT_SPECIAL_REPLY = 0x00000004,
632 IPC_PORT_INIT_FILTER_MESSAGE = 0x00000008,
633 IPC_PORT_INIT_TG_BLOCK_TRACKING = 0x00000010,
634 IPC_PORT_INIT_LOCKED = 0x00000020,
635 IPC_PORT_INIT_REPLY = 0x00000040,
636 IPC_PORT_ENFORCE_REPLY_PORT_SEMANTICS = 0x00000080,
637 IPC_PORT_INIT_PROVISIONAL_REPLY = 0x00000100,
638 IPC_PORT_INIT_PROVISIONAL_ID_PROT_OPTOUT = 0x00000200,
639 IPC_PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS = 0x00000400,
640 });
641
642 /* Initialize a newly-allocated port */
643 extern void ipc_port_init(
644 ipc_port_t port,
645 ipc_space_t space,
646 ipc_port_init_flags_t flags,
647 mach_port_name_t name);
648
649 /* Allocate a port */
650 extern kern_return_t ipc_port_alloc(
651 ipc_space_t space,
652 ipc_port_init_flags_t flags,
653 mach_port_name_t *namep,
654 ipc_port_t *portp);
655
656 /* Allocate a port, with a specific name */
657 extern kern_return_t ipc_port_alloc_name(
658 ipc_space_t space,
659 ipc_port_init_flags_t flags,
660 mach_port_name_t name,
661 ipc_port_t *portp);
662
663 /* Attach a label to the port */
664 extern void ipc_port_set_label(
665 ipc_port_t port,
666 ipc_label_t label);
667
668 /* Generate dead name notifications */
669 extern void ipc_port_dnnotify(
670 ipc_port_t port);
671
672 /* Generate send-possible notifications */
673 extern void ipc_port_spnotify(
674 ipc_port_t port);
675
676 /* Destroy a port */
677 extern void ipc_port_destroy(
678 ipc_port_t port);
679
680 /* Check if queueing "port" in a message for "dest" would create a circular
681 * group of ports and messages */
682 extern boolean_t
683 ipc_port_check_circularity(
684 ipc_port_t port,
685 ipc_port_t dest);
686
687 #if IMPORTANCE_INHERITANCE
688
689 enum {
690 IPID_OPTION_NORMAL = 0, /* normal boost */
691 IPID_OPTION_SENDPOSSIBLE = 1, /* send-possible induced boost */
692 };
693
694 /* link the destination port with special reply port */
695 void
696 ipc_port_link_special_reply_port(
697 ipc_port_t special_reply_port,
698 ipc_port_t dest_port,
699 boolean_t sync_bootstrap_checkin);
700
701 #define IPC_PORT_ADJUST_SR_NONE 0
702 #define IPC_PORT_ADJUST_SR_ALLOW_SYNC_LINKAGE 0x1
703 #define IPC_PORT_ADJUST_SR_LINK_WORKLOOP 0x2
704 #define IPC_PORT_ADJUST_UNLINK_THREAD 0x4
705 #define IPC_PORT_ADJUST_SR_RECEIVED_MSG 0x8
706 #define IPC_PORT_ADJUST_SR_ENABLE_EVENT 0x10
707 #define IPC_PORT_ADJUST_RESET_BOOSTRAP_CHECKIN 0x20
708
709 void
710 ipc_special_reply_port_bits_reset(ipc_port_t special_reply_port);
711
712 void
713 ipc_special_reply_port_msg_sent(ipc_port_t special_reply_port);
714
715 void
716 ipc_special_reply_port_msg_sent(ipc_port_t special_reply_port);
717
718 /* Adjust special reply port linkage */
719 void
720 ipc_port_adjust_special_reply_port_locked(
721 ipc_port_t special_reply_port,
722 struct knote *kn,
723 uint8_t flags,
724 boolean_t get_turnstile);
725
726 void
727 ipc_port_adjust_sync_link_state_locked(
728 ipc_port_t port,
729 int sync_link_state,
730 turnstile_inheritor_t inheritor);
731
732 /* Adjust special reply port linkage */
733 void
734 ipc_port_adjust_special_reply_port(
735 ipc_port_t special_reply_port,
736 uint8_t flags);
737
738 void
739 ipc_port_adjust_port_locked(
740 ipc_port_t port,
741 struct knote *kn,
742 boolean_t sync_bootstrap_checkin);
743
744 void
745 ipc_port_clear_sync_rcv_thread_boost_locked(
746 ipc_port_t port);
747
748 bool
749 ipc_port_has_prdrequest(
750 ipc_port_t port);
751
752 kern_return_t
753 ipc_port_add_watchport_elem_locked(
754 ipc_port_t port,
755 struct task_watchport_elem *watchport_elem,
756 struct task_watchport_elem **old_elem);
757
758 kern_return_t
759 ipc_port_clear_watchport_elem_internal_conditional_locked(
760 ipc_port_t port,
761 struct task_watchport_elem *watchport_elem);
762
763 kern_return_t
764 ipc_port_replace_watchport_elem_conditional_locked(
765 ipc_port_t port,
766 struct task_watchport_elem *old_watchport_elem,
767 struct task_watchport_elem *new_watchport_elem);
768
769 struct task_watchport_elem *
770 ipc_port_clear_watchport_elem_internal(
771 ipc_port_t port);
772
773 void
774 ipc_port_send_turnstile_prepare(ipc_port_t port);
775
776 void
777 ipc_port_send_turnstile_complete(ipc_port_t port);
778
779 struct waitq *
780 ipc_port_rcv_turnstile_waitq(struct waitq *waitq);
781
782 /* apply importance delta to port only */
783 extern mach_port_delta_t
784 ipc_port_impcount_delta(
785 ipc_port_t port,
786 mach_port_delta_t delta,
787 ipc_port_t base);
788
789 /* apply importance delta to port, and return task importance for update */
790 extern boolean_t
791 ipc_port_importance_delta_internal(
792 ipc_port_t port,
793 natural_t options,
794 mach_port_delta_t *deltap,
795 ipc_importance_task_t *imp_task);
796
797 /* Apply an importance delta to a port and reflect change in receiver task */
798 extern boolean_t
799 ipc_port_importance_delta(
800 ipc_port_t port,
801 natural_t options,
802 mach_port_delta_t delta);
803 #endif /* IMPORTANCE_INHERITANCE */
804
805 /*!
806 * @function ipc_port_make_send_any_locked()
807 *
808 * @brief
809 * Makes a naked send right for a locked and active port.
810 *
811 * @decription
812 * @c ipc_port_make_send_*() should not be used in any generic IPC
813 * plumbing, as this is an operation that subsystem owners need
814 * to be able to synchronize against with the make-send-count
815 * and no-senders notifications.
816 *
817 * It is especially important for kobject types, and in general MIG upcalls
818 * or replies from the kernel should never use MAKE_SEND dispositions,
819 * and prefer COPY_SEND or MOVE_SEND, so that subsystems can control
820 * where that send right comes from.
821 *
822 * This function doesn't perform any validation on the type of port,
823 * this duty is left to the caller.
824 *
825 * @param port An active and locked port.
826 */
827 extern ipc_port_t ipc_port_make_send_any_locked(
828 ipc_port_t port);
829
830 /*!
831 * @function ipc_port_make_send_any()
832 *
833 * @brief
834 * Makes a naked send right for the specified port.
835 *
836 * @decription
837 * @see ipc_port_make_send_any_locked() for a general warning about
838 * making send rights.
839 *
840 * This function doesn't perform any validation on the type of port,
841 * this duty is left to the caller.
842 *
843 * Using @c ipc_port_make_send_mqueue() or @c ipc_kobject_make_send()
844 * is preferred.
845 *
846 * @param port The target port.
847 *
848 * @returns
849 * - IP_DEAD if @c port was dead.
850 * - @c port if @c port was valid, in which case
851 * a naked send right was made.
852 */
853 extern ipc_port_t ipc_port_make_send_any(
854 ipc_port_t port) __result_use_check;
855
856 /*!
857 * @function ipc_port_make_send_mqueue()
858 *
859 * @brief
860 * Makes a naked send right for the specified port.
861 *
862 * @decription
863 * @see ipc_port_make_send_any_locked() for a general warning about
864 * making send rights.
865 *
866 * This function will return IP_NULL if the port wasn't a message queue.
867 *
868 * This avoids confusions where kobject ports are being set in places
869 * where the system expects message queues.
870 *
871 * @param port The target port.
872 *
873 * @returns
874 * - IP_NULL if @c port was not a message queue port
875 * (IKOT_NONE), or @c port was IP_NULL.
876 * - IP_DEAD if @c port was dead.
877 * - @c port if @c port was valid, in which case
878 * a naked send right was made.
879 */
880 extern ipc_port_t ipc_port_make_send_mqueue(
881 ipc_port_t port) __result_use_check;
882
883 /*!
884 * @function ipc_port_copy_send_any_locked()
885 *
886 * @brief
887 * Copies a naked send right for a locked and active port.
888 *
889 * @decription
890 * This function doesn't perform any validation on the type of port,
891 * this duty is left to the caller.
892 *
893 * @param port An active and locked port.
894 */
895 extern void ipc_port_copy_send_any_locked(
896 ipc_port_t port);
897
898 /*!
899 * @function ipc_port_make_send_any()
900 *
901 * @brief
902 * Copies a naked send right for the specified port.
903 *
904 * @decription
905 * This function doesn't perform any validation on the type of port,
906 * this duty is left to the caller.
907 *
908 * Using @c ipc_port_copy_send_mqueue() or @c ipc_kobject_copy_send()
909 * is preferred.
910 *
911 * @param port The target port.
912 *
913 * @returns
914 * - IP_DEAD if @c port was dead.
915 * - @c port if @c port was valid, in which case
916 * a naked send right was made.
917 */
918 extern ipc_port_t ipc_port_copy_send_any(
919 ipc_port_t port) __result_use_check;
920
921 /*!
922 * @function ipc_port_copy_send_mqueue()
923 *
924 * @brief
925 * Copies a naked send right for the specified port.
926 *
927 * @decription
928 * This function will return IP_NULL if the port wasn't a message queue.
929 *
930 * This avoids confusions where kobject ports are being set in places
931 * where the system expects message queues.
932 *
933 * @param port The target port.
934 *
935 * @returns
936 * - IP_NULL if @c port was not a message queue port
937 * (IKOT_NONE), or @c port was IP_NULL.
938 * - IP_DEAD if @c port was dead.
939 * - @c port if @c port was valid, in which case
940 * a naked send right was made.
941 */
942 extern ipc_port_t ipc_port_copy_send_mqueue(
943 ipc_port_t port) __result_use_check;
944
945 /* Copyout a naked send right */
946 extern mach_port_name_t ipc_port_copyout_send(
947 ipc_port_t sright,
948 ipc_space_t space);
949
950 extern mach_port_name_t ipc_port_copyout_send_pinned(
951 ipc_port_t sright,
952 ipc_space_t space);
953
954 extern void ipc_port_thread_group_blocked(
955 ipc_port_t port);
956
957 extern void ipc_port_thread_group_unblocked(void);
958
959 extern void ipc_port_release_send_and_unlock(
960 ipc_port_t port);
961 #endif /* MACH_KERNEL_PRIVATE */
962
963 #if KERNEL_PRIVATE
964
965 /* Release a (valid) naked send right */
966 extern void ipc_port_release_send(
967 ipc_port_t port);
968
969 extern void ipc_port_reference(
970 ipc_port_t port);
971
972 extern void ipc_port_release(
973 ipc_port_t port);
974
975 struct thread_attr_for_ipc_propagation {
976 union {
977 struct {
978 uint64_t tafip_iotier:2,
979 tafip_qos:3;
980 };
981 uint64_t tafip_value;
982 };
983 uint64_t tafip_reserved;
984 };
985
986 extern kern_return_t
987 ipc_port_propagate_thread_attr(
988 ipc_port_t port,
989 struct thread_attr_for_ipc_propagation attr);
990
991 extern kern_return_t
992 ipc_port_reset_thread_attr(ipc_port_t port);
993 #endif /* KERNEL_PRIVATE */
994
995 #ifdef MACH_KERNEL_PRIVATE
996
997 /* Make a naked send-once right from a locked and active receive right */
998 extern ipc_port_t ipc_port_make_sonce_locked(
999 ipc_port_t port);
1000
1001 /* Make a naked send-once right from a receive right */
1002 extern ipc_port_t ipc_port_make_sonce(
1003 ipc_port_t port);
1004
1005 /* Release a naked send-once right */
1006 extern void ipc_port_release_sonce(
1007 ipc_port_t port);
1008
1009 /* Release a naked send-once right */
1010 extern void ipc_port_release_sonce_and_unlock(
1011 ipc_port_t port);
1012
1013 /* Release a naked (in limbo or in transit) receive right */
1014 extern void ipc_port_release_receive(
1015 ipc_port_t port);
1016
1017 /* Finalize the destruction of a port before it gets freed */
1018 extern void ipc_port_finalize(
1019 ipc_port_t port);
1020
1021 /* Get receiver task and its pid (if any) for port. Assumes port is locked. */
1022 extern pid_t ipc_port_get_receiver_task_locked(ipc_port_t port, uintptr_t *task);
1023
1024 /* Get receiver task and its pid (if any) for port. */
1025 extern pid_t ipc_port_get_receiver_task(ipc_port_t port, uintptr_t *task);
1026
1027 /* Allocate a port in a special space */
1028 extern ipc_port_t ipc_port_alloc_special(
1029 ipc_space_t space,
1030 ipc_port_init_flags_t flags);
1031
1032 /* Deallocate a port in a special space */
1033 extern void ipc_port_dealloc_special_and_unlock(
1034 ipc_port_t port,
1035 ipc_space_t space);
1036
1037 /* Deallocate a port in a special space */
1038 extern void ipc_port_dealloc_special(
1039 ipc_port_t port,
1040 ipc_space_t space);
1041
1042 extern void ipc_port_recv_update_inheritor(ipc_port_t port,
1043 struct turnstile *turnstile,
1044 turnstile_update_flags_t flags);
1045
1046 extern void ipc_port_send_update_inheritor(ipc_port_t port,
1047 struct turnstile *turnstile,
1048 turnstile_update_flags_t flags);
1049
1050 extern int
1051 ipc_special_reply_get_pid_locked(ipc_port_t port);
1052
1053 #define ipc_port_alloc_reply() \
1054 ipc_port_alloc_special(ipc_space_reply, IPC_PORT_INIT_MESSAGE_QUEUE | IPC_PORT_INIT_SPECIAL_REPLY)
1055 #define ipc_port_dealloc_reply(port) \
1056 ipc_port_dealloc_special((port), ipc_space_reply)
1057
1058 #endif /* MACH_KERNEL_PRIVATE */
1059
1060 #endif /* _IPC_IPC_PORT_H_ */
1061