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