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_port_lock(port)
303 #define ip_mq_lock_check_aligned(port) ipc_port_lock_check_aligned(port)
304 #define ip_mq_lock_try(port) ipc_port_lock_try(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
315 #define ip_from_waitq(wq) __container_of(wq, struct ipc_port, ip_waitq)
316 #define ip_from_mq(mq) __container_of(mq, struct ipc_port, ip_messages)
317
318 #define ip_kotype(port) io_kotype(ip_to_object(port))
319 #define ip_is_kobject(port) io_is_kobject(ip_to_object(port))
320 #define ip_is_control(port) \
321 (ip_kotype(port) == IKOT_TASK_CONTROL || ip_kotype(port) == IKOT_THREAD_CONTROL)
322 #define ip_is_kolabeled(port) io_is_kolabeled(ip_to_object(port))
323
324 #define ip_full_kernel(port) imq_full_kernel(&(port)->ip_messages)
325 #define ip_full(port) imq_full(&(port)->ip_messages)
326
327 /*
328 * IPC Port flags for reply port defense in depth
329 *
330 * PORT_MARK_REPLY_PORT
331 * Port is marked as a reply port.
332 *
333 * PORT_ENFORCE_REPLY_PORT_SEMANTICS
334 * When talking to this port, the local port of mach msg needs to be a reply port.
335 * Currrently service ports and libxpc connection ports adopt this.
336 *
337 * PORT_MARK_PROVISIONAL_REPLY_PORT
338 * Port is marked as a provisional reply port with an eventual goal of making it port as PORT_MARK_REPLY_PORT.
339 *
340 * PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS
341 * Same as PORT_ENFORCE_REPLY_PORT_SEMANTICS above, but does not allow for provisional reply ports.
342 * Once provisional reply ports no longer exist, this will be removed as "rigidness/strictness" will be irrelavant.
343 *
344 * PORT_MARK_EXCEPTION_PORT
345 * Port is used as a mach exception port. It has an immovable receive right and can be used in the
346 * hardened exception flow provided by `task_register_hardened_exception_handler`
347 */
348 #define PORT_MARK_REPLY_PORT 0x01
349 #define PORT_ENFORCE_REPLY_PORT_SEMANTICS 0x02
350 #define PORT_MARK_PROVISIONAL_REPLY_PORT 0x03
351 #define PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS 0x04
352 #define PORT_MARK_EXCEPTION_PORT 0x05
353
354 /* ip_reply_port_semantics can be read without a lock as it is never unset after port creation. */
355 #define ip_is_reply_port(port) (((port)->ip_reply_port_semantics) == PORT_MARK_REPLY_PORT)
356 #define ip_require_reply_port_semantics(port) (((port)->ip_reply_port_semantics) == PORT_ENFORCE_REPLY_PORT_SEMANTICS)
357 #define ip_is_provisional_reply_port(port) (((port)->ip_reply_port_semantics) == PORT_MARK_PROVISIONAL_REPLY_PORT)
358 #define ip_require_rigid_reply_port_semantics(port) (((port)->ip_reply_port_semantics) == PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS)
359 #define ip_is_exception_port(port) (((port)->ip_reply_port_semantics) == PORT_MARK_EXCEPTION_PORT)
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_rigid_reply_port_semantics(port) ((port)->ip_reply_port_semantics = PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS)
365 #define ip_mark_exception_port(port) ((port)->ip_reply_port_semantics = PORT_MARK_EXCEPTION_PORT)
366
367 #define ip_is_immovable_send(port) ((port)->ip_immovable_send)
368 #define ip_is_pinned(port) ((port)->ip_pinned)
369
370 #define ip_is_libxpc_connection_port(port) \
371 (!ip_is_kolabeled(port) && (!(port)->ip_service_port) && ((port)->ip_splabel != NULL))
372
373 /* Bits reserved in IO_BITS_PORT_INFO are defined here */
374
375 /*
376 * This flag indicates that the port has opted into message filtering based
377 * on a policy defined in the Sandbox.
378 */
379 #define IP_BIT_FILTER_MSG 0x00001000
380 #define ip_enforce_msg_filtering(port) ((io_bits(ip_to_object(port)) & IP_BIT_FILTER_MSG) != 0)
381
382 /*
383 * Use the low bits in the ipr_soright to specify the request type
384 */
385 __enum_decl(ipc_port_request_opts_t, uintptr_t, {
386 IPR_SOR_SPARM_MASK = 0x01, /* send-possible armed */
387 IPR_SOR_SPREQ_MASK = 0x02, /* send-possible requested */
388 });
389 #define IPR_SOR_SPBIT_MASK 3 /* combo */
390 #define IPR_SOR_SPARMED(sor) (((uintptr_t)(sor) & IPR_SOR_SPARM_MASK) != 0)
391 #define IPR_SOR_SPREQ(sor) (((uintptr_t)(sor) & IPR_SOR_SPREQ_MASK) != 0)
392 #define IPR_SOR_PORT(sor) ((ipc_port_t)((uintptr_t)(sor) & ~IPR_SOR_SPBIT_MASK))
393 #define IPR_SOR_MAKE(p, m) ((ipc_port_t)((uintptr_t)(p) | (m)))
394
395 extern lck_grp_t ipc_lck_grp;
396 extern lck_attr_t ipc_lck_attr;
397
398 /*
399 * Taking the ipc_port_multiple lock grants the privilege
400 * to lock multiple ports at once. No ports must locked
401 * when it is taken.
402 */
403
404 extern lck_spin_t ipc_port_multiple_lock_data;
405
406 #define ipc_port_multiple_lock() \
407 lck_spin_lock_grp(&ipc_port_multiple_lock_data, &ipc_lck_grp)
408
409 #define ipc_port_multiple_unlock() \
410 lck_spin_unlock(&ipc_port_multiple_lock_data)
411
412 /*
413 * Search for the end of the chain (a port not in transit),
414 * acquiring locks along the way.
415 */
416 extern boolean_t ipc_port_destination_chain_lock(
417 ipc_port_t port,
418 ipc_port_t *base);
419
420 /*
421 * The port timestamp facility provides timestamps
422 * for port destruction. It is used to serialize
423 * mach_port_names with port death.
424 */
425
426 extern ipc_port_timestamp_t ipc_port_timestamp_data;
427
428 /* Retrieve a port timestamp value */
429 extern ipc_port_timestamp_t ipc_port_timestamp(void);
430
431 /*
432 * Compares two timestamps, and returns TRUE if one
433 * happened before two. Note that this formulation
434 * works when the timestamp wraps around at 2^32,
435 * as long as one and two aren't too far apart.
436 */
437
438 #define IP_TIMESTAMP_ORDER(one, two) ((int) ((one) - (two)) < 0)
439
440 extern void __abortlike __ipc_port_inactive_panic(ipc_port_t port);
441
442 static inline void
require_ip_active(ipc_port_t port)443 require_ip_active(ipc_port_t port)
444 {
445 if (!ip_active(port)) {
446 __ipc_port_inactive_panic(port);
447 }
448 }
449
450 /*
451 * A receive right (port) can be in ONE of the following four states:
452 *
453 * 1) INACTIVE: Dead
454 * 2) IN-SPACE: In a space
455 * 3) IN-TRANSIT: Enqueued in a message
456 * 4) IN-LIMBO
457 *
458 * If the port is active and ip_receiver_name != MACH_PORT_NULL, we can safely
459 * deference the union as ip_receiver, which points to the space that holds
460 * receive right (but doesn't hold a ref for it).
461 *
462 * If the port is active and ip_receiver_name == MACH_PORT_NULL, we can safely
463 * deference the union as ip_destination. The port is either IN-LIMBO (ip_destination == IP_NULL)
464 * or ip_destination points to the destination port and holds a ref for it.
465 *
466 * If the port is not active, we can safely deference the union as ip_timestamp,
467 * which contains a timestamp taken when the port was destroyed.
468 *
469 * If the port is in a space, ip_receiver_name denotes the port name its receive
470 * right occupies in the receiving space. The only exception, as an optimization trick,
471 * is task's self port (itk_self), whose ip_receiver_name actually denotes the name
472 * of mach_task_self() in owning task's space (a send right, with receive right in ipc_space_kernel).
473 */
474
475 static inline bool
ip_in_a_space(ipc_port_t port)476 ip_in_a_space(ipc_port_t port)
477 {
478 /* IN-SPACE */
479 return ip_active(port) && port->ip_receiver_name != MACH_PORT_NULL;
480 }
481
482 static inline bool
ip_in_space(ipc_port_t port,ipc_space_t space)483 ip_in_space(ipc_port_t port, ipc_space_t space)
484 {
485 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
486 return ip_in_a_space(port) && port->ip_receiver == space;
487 }
488
489 /* use sparsely when port lock is not possible, just compare raw pointer */
490 static inline bool
ip_in_space_noauth(ipc_port_t port,void * space)491 ip_in_space_noauth(ipc_port_t port, void* space)
492 {
493 void *__single raw_ptr = ptrauth_strip(*(void **)&port->ip_receiver, ptrauth_key_process_independent_data);
494 return raw_ptr == space;
495 }
496
497 static inline bool
ip_in_transit(ipc_port_t port)498 ip_in_transit(ipc_port_t port)
499 {
500 /* IN-TRANSIT */
501 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
502 return ip_active(port) && !ip_in_a_space(port) && port->ip_destination != IP_NULL;
503 }
504
505 static inline bool
ip_in_limbo(ipc_port_t port)506 ip_in_limbo(ipc_port_t port)
507 {
508 /* IN-LIMBO */
509 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
510 return ip_active(port) && !ip_in_a_space(port) && port->ip_destination == IP_NULL;
511 }
512
513 static inline ipc_space_t
ip_get_receiver(ipc_port_t port)514 ip_get_receiver(ipc_port_t port)
515 {
516 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
517 return ip_in_a_space(port) ? port->ip_receiver : NULL;
518 }
519
520 static inline void*
ip_get_receiver_ptr_noauth(ipc_port_t port)521 ip_get_receiver_ptr_noauth(ipc_port_t port)
522 {
523 void *__single raw_ptr = ptrauth_strip(*(void **)&port->ip_receiver, ptrauth_key_process_independent_data);
524 return raw_ptr;
525 }
526
527 static inline mach_port_name_t
ip_get_receiver_name(ipc_port_t port)528 ip_get_receiver_name(ipc_port_t port)
529 {
530 return ip_in_a_space(port) ? port->ip_receiver_name : MACH_PORT_NULL;
531 }
532
533 static inline ipc_port_t
ip_get_destination(ipc_port_t port)534 ip_get_destination(ipc_port_t port)
535 {
536 ip_mq_lock_held(port); /* port must be locked, otherwise PAC could fail */
537 return ip_active(port) && !ip_in_a_space(port) ? port->ip_destination : IP_NULL;
538 }
539
540 static inline ipc_port_timestamp_t
ip_get_death_time(ipc_port_t port)541 ip_get_death_time(ipc_port_t port)
542 {
543 assert(!ip_active(port));
544 return port->ip_timestamp;
545 }
546
547 static inline ipc_importance_task_t
ip_get_imp_task(ipc_port_t port)548 ip_get_imp_task(ipc_port_t port)
549 {
550 return (!ip_is_kobject(port) && !port->ip_specialreply && port->ip_tempowner) ? port->ip_imp_task : IIT_NULL;
551 }
552
553 extern kern_return_t ipc_port_translate_send(
554 ipc_space_t space,
555 mach_port_name_t name,
556 ipc_port_t *portp);
557
558 extern kern_return_t ipc_port_translate_receive(
559 ipc_space_t space,
560 mach_port_name_t name,
561 ipc_port_t *portp);
562
563 /* Allocate a notification request slot */
564 extern kern_return_t ipc_port_request_alloc(
565 ipc_port_t port,
566 mach_port_name_t name,
567 ipc_port_t soright,
568 ipc_port_request_opts_t options,
569 ipc_port_request_index_t *indexp);
570
571 extern kern_return_t ipc_port_request_hnotify_alloc(
572 ipc_port_t port,
573 struct host_notify_entry *hnotify,
574 ipc_port_request_index_t *indexp);
575
576 /* Grow one of a port's tables of notifcation requests */
577 extern kern_return_t ipc_port_request_grow(
578 ipc_port_t port);
579
580 /* Return the type(s) of notification requests outstanding */
581 extern mach_port_type_t ipc_port_request_type(
582 ipc_port_t port,
583 mach_port_name_t name,
584 ipc_port_request_index_t index);
585
586 /* Cancel a notification request and return the send-once right */
587 extern ipc_port_t ipc_port_request_cancel(
588 ipc_port_t port,
589 mach_port_name_t name,
590 ipc_port_request_index_t index);
591
592 /* Arm any delayed send-possible notification */
593 extern bool ipc_port_request_sparm(
594 ipc_port_t port,
595 mach_port_name_t name,
596 ipc_port_request_index_t index,
597 mach_msg_option64_t option,
598 mach_msg_priority_t priority);
599
600 /* Make a no-senders request */
601 extern void ipc_port_nsrequest(
602 ipc_port_t port,
603 mach_port_mscount_t sync,
604 ipc_port_t notify,
605 ipc_port_t *previousp);
606
607 /* Prepare a receive right for transmission/destruction */
608 extern boolean_t ipc_port_clear_receiver(
609 ipc_port_t port,
610 boolean_t should_destroy,
611 waitq_link_list_t *free_l);
612
613 __options_decl(ipc_port_init_flags_t, uint32_t, {
614 IPC_PORT_INIT_NONE = 0x00000000,
615 IPC_PORT_INIT_MAKE_SEND_RIGHT = 0x00000001,
616 IPC_PORT_INIT_MESSAGE_QUEUE = 0x00000002,
617 IPC_PORT_INIT_SPECIAL_REPLY = 0x00000004,
618 IPC_PORT_INIT_FILTER_MESSAGE = 0x00000008,
619 IPC_PORT_INIT_TG_BLOCK_TRACKING = 0x00000010,
620 IPC_PORT_INIT_LOCKED = 0x00000020,
621 IPC_PORT_INIT_REPLY = 0x00000040,
622 IPC_PORT_ENFORCE_REPLY_PORT_SEMANTICS = 0x00000080,
623 IPC_PORT_INIT_PROVISIONAL_REPLY = 0x00000100,
624 IPC_PORT_ENFORCE_RIGID_REPLY_PORT_SEMANTICS = 0x00000400,
625 IPC_PORT_INIT_EXCEPTION_PORT = 0x00000800,
626 });
627
628 /* Initialize a newly-allocated port */
629 extern void ipc_port_init(
630 ipc_port_t port,
631 ipc_space_t space,
632 ipc_port_init_flags_t flags,
633 mach_port_name_t name);
634
635 extern void ipc_port_lock(
636 ipc_port_t port);
637
638 extern void ipc_port_lock_check_aligned(
639 ipc_port_t port);
640
641 extern bool ipc_port_lock_try(
642 ipc_port_t port);
643
644 /* Allocate a port */
645 extern kern_return_t ipc_port_alloc(
646 ipc_space_t space,
647 ipc_port_init_flags_t flags,
648 mach_port_name_t *namep,
649 ipc_port_t *portp);
650
651 /* Allocate a port, with a specific name */
652 extern kern_return_t ipc_port_alloc_name(
653 ipc_space_t space,
654 ipc_port_init_flags_t flags,
655 mach_port_name_t name,
656 ipc_port_t *portp);
657
658 /* Attach a label to the port */
659 extern void ipc_port_set_label(
660 ipc_port_t port,
661 ipc_label_t label);
662
663 /* Generate dead name notifications */
664 extern void ipc_port_dnnotify(
665 ipc_port_t port);
666
667 /* Generate send-possible notifications */
668 extern void ipc_port_spnotify(
669 ipc_port_t port);
670
671 /* Destroy a port */
672 extern void ipc_port_destroy(
673 ipc_port_t port);
674
675 /* Check if queueing "port" in a message for "dest" would create a circular
676 * group of ports and messages */
677 extern boolean_t
678 ipc_port_check_circularity(
679 ipc_port_t port,
680 ipc_port_t dest);
681
682 #if IMPORTANCE_INHERITANCE
683
684 enum {
685 IPID_OPTION_NORMAL = 0, /* normal boost */
686 IPID_OPTION_SENDPOSSIBLE = 1, /* send-possible induced boost */
687 };
688
689 /* link the destination port with special reply port */
690 void
691 ipc_port_link_special_reply_port(
692 ipc_port_t special_reply_port,
693 ipc_port_t dest_port,
694 boolean_t sync_bootstrap_checkin);
695
696 #define IPC_PORT_ADJUST_SR_NONE 0
697 #define IPC_PORT_ADJUST_SR_ALLOW_SYNC_LINKAGE 0x1
698 #define IPC_PORT_ADJUST_SR_LINK_WORKLOOP 0x2
699 #define IPC_PORT_ADJUST_UNLINK_THREAD 0x4
700 #define IPC_PORT_ADJUST_SR_RECEIVED_MSG 0x8
701 #define IPC_PORT_ADJUST_SR_ENABLE_EVENT 0x10
702 #define IPC_PORT_ADJUST_RESET_BOOSTRAP_CHECKIN 0x20
703
704 void
705 ipc_special_reply_port_bits_reset(ipc_port_t special_reply_port);
706
707 void
708 ipc_special_reply_port_msg_sent(ipc_port_t special_reply_port);
709
710 void
711 ipc_special_reply_port_msg_sent(ipc_port_t special_reply_port);
712
713 /* Adjust special reply port linkage */
714 void
715 ipc_port_adjust_special_reply_port_locked(
716 ipc_port_t special_reply_port,
717 struct knote *kn,
718 uint8_t flags,
719 boolean_t get_turnstile);
720
721 void
722 ipc_port_adjust_sync_link_state_locked(
723 ipc_port_t port,
724 int sync_link_state,
725 turnstile_inheritor_t inheritor);
726
727 /* Adjust special reply port linkage */
728 void
729 ipc_port_adjust_special_reply_port(
730 ipc_port_t special_reply_port,
731 uint8_t flags);
732
733 void
734 ipc_port_adjust_port_locked(
735 ipc_port_t port,
736 struct knote *kn,
737 boolean_t sync_bootstrap_checkin);
738
739 void
740 ipc_port_clear_sync_rcv_thread_boost_locked(
741 ipc_port_t port);
742
743 bool
744 ipc_port_has_prdrequest(
745 ipc_port_t port);
746
747 kern_return_t
748 ipc_port_add_watchport_elem_locked(
749 ipc_port_t port,
750 struct task_watchport_elem *watchport_elem,
751 struct task_watchport_elem **old_elem);
752
753 kern_return_t
754 ipc_port_clear_watchport_elem_internal_conditional_locked(
755 ipc_port_t port,
756 struct task_watchport_elem *watchport_elem);
757
758 kern_return_t
759 ipc_port_replace_watchport_elem_conditional_locked(
760 ipc_port_t port,
761 struct task_watchport_elem *old_watchport_elem,
762 struct task_watchport_elem *new_watchport_elem);
763
764 struct task_watchport_elem *
765 ipc_port_clear_watchport_elem_internal(
766 ipc_port_t port);
767
768 void
769 ipc_port_send_turnstile_prepare(ipc_port_t port);
770
771 void
772 ipc_port_send_turnstile_complete(ipc_port_t port);
773
774 struct waitq *
775 ipc_port_rcv_turnstile_waitq(struct waitq *waitq);
776
777 /* apply importance delta to port only */
778 extern mach_port_delta_t
779 ipc_port_impcount_delta(
780 ipc_port_t port,
781 mach_port_delta_t delta,
782 ipc_port_t base);
783
784 /* apply importance delta to port, and return task importance for update */
785 extern boolean_t
786 ipc_port_importance_delta_internal(
787 ipc_port_t port,
788 natural_t options,
789 mach_port_delta_t *deltap,
790 ipc_importance_task_t *imp_task);
791
792 /* Apply an importance delta to a port and reflect change in receiver task */
793 extern boolean_t
794 ipc_port_importance_delta(
795 ipc_port_t port,
796 natural_t options,
797 mach_port_delta_t delta);
798 #endif /* IMPORTANCE_INHERITANCE */
799
800 /*!
801 * @function ipc_port_make_send_any_locked()
802 *
803 * @brief
804 * Makes a naked send right for a locked and active port.
805 *
806 * @decription
807 * @c ipc_port_make_send_*() should not be used in any generic IPC
808 * plumbing, as this is an operation that subsystem owners need
809 * to be able to synchronize against with the make-send-count
810 * and no-senders notifications.
811 *
812 * It is especially important for kobject types, and in general MIG upcalls
813 * or replies from the kernel should never use MAKE_SEND dispositions,
814 * and prefer COPY_SEND or MOVE_SEND, so that subsystems can control
815 * where that send right comes from.
816 *
817 * This function doesn't perform any validation on the type of port,
818 * this duty is left to the caller.
819 *
820 * @param port An active and locked port.
821 */
822 extern ipc_port_t ipc_port_make_send_any_locked(
823 ipc_port_t port);
824
825 /*!
826 * @function ipc_port_make_send_any()
827 *
828 * @brief
829 * Makes a naked send right for the specified port.
830 *
831 * @decription
832 * @see ipc_port_make_send_any_locked() for a general warning about
833 * making send rights.
834 *
835 * This function doesn't perform any validation on the type of port,
836 * this duty is left to the caller.
837 *
838 * Using @c ipc_port_make_send_mqueue() or @c ipc_kobject_make_send()
839 * is preferred.
840 *
841 * @param port The target port.
842 *
843 * @returns
844 * - IP_DEAD if @c port was dead.
845 * - @c port if @c port was valid, in which case
846 * a naked send right was made.
847 */
848 extern ipc_port_t ipc_port_make_send_any(
849 ipc_port_t port) __result_use_check;
850
851 /*!
852 * @function ipc_port_make_send_mqueue()
853 *
854 * @brief
855 * Makes a naked send right for the specified port.
856 *
857 * @decription
858 * @see ipc_port_make_send_any_locked() for a general warning about
859 * making send rights.
860 *
861 * This function will return IP_NULL if the port wasn't a message queue.
862 *
863 * This avoids confusions where kobject ports are being set in places
864 * where the system expects message queues.
865 *
866 * @param port The target port.
867 *
868 * @returns
869 * - IP_NULL if @c port was not a message queue port
870 * (IKOT_NONE), or @c port was IP_NULL.
871 * - IP_DEAD if @c port was dead.
872 * - @c port if @c port was valid, in which case
873 * a naked send right was made.
874 */
875 extern ipc_port_t ipc_port_make_send_mqueue(
876 ipc_port_t port) __result_use_check;
877
878 /*!
879 * @function ipc_port_copy_send_any_locked()
880 *
881 * @brief
882 * Copies a naked send right for a locked and active port.
883 *
884 * @decription
885 * This function doesn't perform any validation on the type of port,
886 * this duty is left to the caller.
887 *
888 * @param port An active and locked port.
889 */
890 extern void ipc_port_copy_send_any_locked(
891 ipc_port_t port);
892
893 /*!
894 * @function ipc_port_make_send_any()
895 *
896 * @brief
897 * Copies a naked send right for the specified port.
898 *
899 * @decription
900 * This function doesn't perform any validation on the type of port,
901 * this duty is left to the caller.
902 *
903 * Using @c ipc_port_copy_send_mqueue() or @c ipc_kobject_copy_send()
904 * is preferred.
905 *
906 * @param port The target port.
907 *
908 * @returns
909 * - IP_DEAD if @c port was dead.
910 * - @c port if @c port was valid, in which case
911 * a naked send right was made.
912 */
913 extern ipc_port_t ipc_port_copy_send_any(
914 ipc_port_t port) __result_use_check;
915
916 /*!
917 * @function ipc_port_copy_send_mqueue()
918 *
919 * @brief
920 * Copies a naked send right for the specified port.
921 *
922 * @decription
923 * This function will return IP_NULL if the port wasn't a message queue.
924 *
925 * This avoids confusions where kobject ports are being set in places
926 * where the system expects message queues.
927 *
928 * @param port The target port.
929 *
930 * @returns
931 * - IP_NULL if @c port was not a message queue port
932 * (IKOT_NONE), or @c port was IP_NULL.
933 * - IP_DEAD if @c port was dead.
934 * - @c port if @c port was valid, in which case
935 * a naked send right was made.
936 */
937 extern ipc_port_t ipc_port_copy_send_mqueue(
938 ipc_port_t port) __result_use_check;
939
940 /* Copyout a naked send right */
941 extern mach_port_name_t ipc_port_copyout_send(
942 ipc_port_t sright,
943 ipc_space_t space);
944
945 extern mach_port_name_t ipc_port_copyout_send_pinned(
946 ipc_port_t sright,
947 ipc_space_t space);
948
949 extern void ipc_port_thread_group_blocked(
950 ipc_port_t port);
951
952 extern void ipc_port_thread_group_unblocked(void);
953
954 extern void ipc_port_release_send_and_unlock(
955 ipc_port_t port);
956
957 extern kern_return_t mach_port_deallocate_kernel(
958 ipc_space_t space,
959 mach_port_name_t name,
960 natural_t kotype);
961
962 #endif /* MACH_KERNEL_PRIVATE */
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