1 /*
2 * Copyright (c) 2000-2019 Apple 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_FREE_COPYRIGHT@
30 */
31 /*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 * Software Distribution Coordinator or [email protected]
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56 /*
57 */
58 /*
59 * File: thread.h
60 * Author: Avadis Tevanian, Jr.
61 *
62 * This file contains the structure definitions for threads.
63 *
64 */
65 /*
66 * Copyright (c) 1993 The University of Utah and
67 * the Computer Systems Laboratory (CSL). All rights reserved.
68 *
69 * Permission to use, copy, modify and distribute this software and its
70 * documentation is hereby granted, provided that both the copyright
71 * notice and this permission notice appear in all copies of the
72 * software, derivative works or modified versions, and any portions
73 * thereof, and that both notices appear in supporting documentation.
74 *
75 * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS
76 * IS" CONDITION. THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF
77 * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
78 *
79 * CSL requests users of this software to return to [email protected] any
80 * improvements that they make and grant CSL redistribution rights.
81 *
82 */
83
84 #ifndef _KERN_THREAD_H_
85 #define _KERN_THREAD_H_
86
87 #include <mach/kern_return.h>
88 #include <mach/mach_types.h>
89 #include <mach/mach_param.h>
90 #include <mach/message.h>
91 #include <mach/boolean.h>
92 #include <mach/vm_param.h>
93 #include <mach/thread_info.h>
94 #include <mach/thread_status.h>
95 #include <mach/exception_types.h>
96
97 #include <kern/kern_types.h>
98 #include <vm/vm_kern.h>
99 #include <sys/cdefs.h>
100 #include <sys/_types/_size_t.h>
101
102 #ifdef MACH_KERNEL_PRIVATE
103 #include <mach_assert.h>
104 #include <mach_ldebug.h>
105
106 #include <ipc/ipc_types.h>
107
108 #include <mach/port.h>
109 #include <kern/cpu_number.h>
110 #include <kern/smp.h>
111 #include <kern/queue.h>
112
113 #include <kern/timer.h>
114 #include <kern/simple_lock.h>
115 #include <kern/locks.h>
116 #include <kern/sched.h>
117 #include <kern/sched_prim.h>
118 #include <mach/sfi_class.h>
119 #include <kern/thread_call.h>
120 #include <kern/thread_group.h>
121 #include <kern/timer_call.h>
122 #include <kern/task.h>
123 #include <kern/exception.h>
124 #include <kern/affinity.h>
125 #include <kern/debug.h>
126 #include <kern/block_hint.h>
127 #include <kern/recount.h>
128 #include <kern/turnstile.h>
129 #include <kern/mpsc_queue.h>
130
131 #if CONFIG_EXCLAVES
132 #include <mach/exclaves.h>
133 #endif /* CONFIG_EXCLAVES */
134
135 #include <kern/waitq.h>
136 #include <san/kasan.h>
137 #include <san/kcov_data.h>
138 #include <os/refcnt.h>
139
140 #include <ipc/ipc_kmsg.h>
141
142 #include <machine/atomic.h>
143 #include <machine/cpu_data.h>
144 #include <machine/thread.h>
145
146 #endif /* MACH_KERNEL_PRIVATE */
147 #ifdef XNU_KERNEL_PRIVATE
148 /* priority queue static asserts fail for __ARM64_ARCH_8_32__ kext builds */
149 #include <kern/priority_queue.h>
150 #endif /* XNU_KERNEL_PRIVATE */
151
152 __BEGIN_DECLS
153
154 #ifdef XNU_KERNEL_PRIVATE
155 #if CONFIG_TASKWATCH
156 /* Taskwatch related. TODO: find this a better home */
157 typedef struct task_watcher task_watch_t;
158 #endif /* CONFIG_TASKWATCH */
159
160 /* Thread tags; for easy identification. */
161 __options_closed_decl(thread_tag_t, uint16_t, {
162 THREAD_TAG_MAINTHREAD = 0x01,
163 THREAD_TAG_CALLOUT = 0x02,
164 THREAD_TAG_IOWORKLOOP = 0x04,
165 THREAD_TAG_PTHREAD = 0x10,
166 THREAD_TAG_WORKQUEUE = 0x20,
167 THREAD_TAG_USER_JOIN = 0x40,
168 });
169
170 typedef struct thread_ro *thread_ro_t;
171
172 /*!
173 * @struct thread_ro
174 *
175 * @brief
176 * A structure allocated in a read only zone that safely
177 * represents the linkages of a thread to its cred, proc, task, ...
178 *
179 * @discussion
180 * The lifetime of a @c thread_ro structure is 1:1 with that
181 * of a @c thread_t or a @c uthread_t and holding a thread reference
182 * always allows to dereference this structure safely.
183 */
184 struct thread_ro {
185 struct thread *tro_owner;
186 #if MACH_BSD
187 __xnu_struct_group(thread_ro_creds, tro_creds, {
188 /*
189 * @c tro_cred holds the current thread credentials.
190 *
191 * For most threads, this is a cache of the proc's
192 * credentials that has been updated at the last
193 * syscall boundary via current_cached_proc_cred_update().
194 *
195 * If the thread assumed a different identity using settid(),
196 * then the proc cached credential lives in @c tro_realcred
197 * instead.
198 */
199 struct ucred *tro_cred;
200 struct ucred *tro_realcred;
201 });
202 struct proc *tro_proc;
203 struct proc_ro *tro_proc_ro;
204 #endif
205 struct task *tro_task;
206
207 struct ipc_port *tro_self_port;
208 #if CONFIG_CSR
209 struct ipc_port *tro_settable_self_port; /* send right */
210 #endif /* CONFIG_CSR */
211 struct ipc_port *tro_ports[THREAD_SELF_PORT_COUNT]; /* no right */
212
213 struct exception_action *tro_exc_actions;
214 };
215
216 /*
217 * Flags for `thread set status`.
218 */
219 __options_decl(thread_set_status_flags_t, uint32_t, {
220 TSSF_FLAGS_NONE = 0,
221
222 /* Translate the state to user. */
223 TSSF_TRANSLATE_TO_USER = 0x01,
224
225 /* Translate the state to user. Preserve flags */
226 TSSF_PRESERVE_FLAGS = 0x02,
227
228 /* Check kernel signed flag */
229 TSSF_CHECK_USER_FLAGS = 0x04,
230
231 /* Allow only user state PTRS */
232 TSSF_ALLOW_ONLY_USER_PTRS = 0x08,
233
234 /* Generate random diversifier and stash it */
235 TSSF_RANDOM_USER_DIV = 0x10,
236
237 /* Stash sigreturn token */
238 TSSF_STASH_SIGRETURN_TOKEN = 0x20,
239
240 /* Check sigreturn token */
241 TSSF_CHECK_SIGRETURN_TOKEN = 0x40,
242
243 /* Allow only matching sigreturn token */
244 TSSF_ALLOW_ONLY_MATCHING_TOKEN = 0x80,
245
246 /* Stash diversifier from thread */
247 TSSF_THREAD_USER_DIV = 0x100,
248
249 /* Check for entitlement */
250 TSSF_CHECK_ENTITLEMENT = 0x200,
251
252 /* Stash diversifier from task */
253 TSSF_TASK_USER_DIV = 0x400,
254
255 /* Only take the PC from the new thread state */
256 TSSF_ONLY_PC = 0x800,
257 });
258
259 /*
260 * Size in bits of compact thread id (ctid).
261 */
262 #define CTID_SIZE_BIT 20
263 typedef uint32_t ctid_t;
264
265 #endif /* XNU_KERNEL_PRIVATE */
266 #ifdef MACH_KERNEL_PRIVATE
267
268 extern zone_t thread_ro_zone;
269
270 __options_decl(thread_work_interval_flags_t, uint32_t, {
271 TH_WORK_INTERVAL_FLAGS_NONE = 0x0,
272 #if CONFIG_SCHED_AUTO_JOIN
273 /* Flags to indicate status about work interval thread is currently part of */
274 TH_WORK_INTERVAL_FLAGS_AUTO_JOIN_LEAK = 0x1,
275 #endif /* CONFIG_SCHED_AUTO_JOIN */
276 TH_WORK_INTERVAL_FLAGS_HAS_WORKLOAD_ID = 0x2,
277 TH_WORK_INTERVAL_FLAGS_RT_ALLOWED = 0x4,
278 });
279
280 #if CONFIG_EXCLAVES
281 /* Thread exclaves interrupt-safe state bits (ORd) */
282 __options_decl(thread_exclaves_intstate_flags_t, uint32_t, {
283 /* Thread is currently executing in secure kernel or exclaves userspace
284 * or was interrupted/preempted while doing so. */
285 TH_EXCLAVES_EXECUTION = 0x1,
286 });
287
288 __options_decl(thread_exclaves_state_flags_t, uint16_t, {
289 /* Thread exclaves state bits (ORd) */
290 /* Thread is handling RPC from a client in xnu or Darwin userspace (but
291 * may have returned to xnu due to an exclaves scheduler request or having
292 * upcalled). Must not re-enter exclaves via RPC or return to Darwin
293 * userspace. */
294 TH_EXCLAVES_RPC = 0x1,
295 /* Thread has made an upcall RPC request back into xnu while handling RPC
296 * into exclaves from a client in xnu or Darwin userspace. Must not
297 * re-enter exclaves via RPC or return to Darwin userspace. */
298 TH_EXCLAVES_UPCALL = 0x2,
299 /* Thread has made an exclaves scheduler request (such as a wait or wake)
300 * from the xnu scheduler while handling RPC into exclaves from a client in
301 * xnu or Darwin userspace. Must not re-enter exclaves via RPC or return to
302 * Darwin userspace. */
303 TH_EXCLAVES_SCHEDULER_REQUEST = 0x4,
304 /* Thread is calling into xnu proxy server directly (but may have
305 * returned to xnu due to an exclaves scheduler request or having
306 * upcalled). Must not re-enter exclaves or return to Darwin userspace.
307 */
308 TH_EXCLAVES_XNUPROXY = 0x8,
309 /* Thread is calling into the exclaves scheduler directly.
310 * Must not re-enter exclaves or return to Darwin userspace.
311 */
312 TH_EXCLAVES_SCHEDULER_CALL = 0x10,
313 /* Thread has called the stop upcall and once the thread returns from
314 * downcall, exit_with_reason needs to be called on the task.
315 */
316 TH_EXCLAVES_STOP_UPCALL_PENDING = 0x20,
317 /* Thread is expecting that an exclaves-side thread may be spawned.
318 */
319 TH_EXCLAVES_SPAWN_EXPECTED = 0x40,
320 /* Thread is resuming the panic thread.
321 * Must not re-enter exclaves or return to Darwin userspace.
322 */
323 TH_EXCLAVES_RESUME_PANIC_THREAD = 0x80,
324 });
325 #define TH_EXCLAVES_STATE_ANY ( \
326 TH_EXCLAVES_RPC | \
327 TH_EXCLAVES_UPCALL | \
328 TH_EXCLAVES_SCHEDULER_REQUEST | \
329 TH_EXCLAVES_XNUPROXY | \
330 TH_EXCLAVES_SCHEDULER_CALL | \
331 TH_EXCLAVES_RESUME_PANIC_THREAD)
332
333 __options_decl(thread_exclaves_inspection_flags_t, uint16_t, {
334 /* Thread is on Stackshot's inspection queue */
335 TH_EXCLAVES_INSPECTION_STACKSHOT = 0x1,
336 /* Thread is on Kperf's inspection queue */
337 TH_EXCLAVES_INSPECTION_KPERF = 0x2,
338 /* Thread must not be inspected (may deadlock, etc.) - set by collector thread*/
339 TH_EXCLAVES_INSPECTION_NOINSPECT = 0x8000,
340 });
341
342 #endif /* CONFIG_EXCLAVES */
343
344 typedef union thread_rr_state {
345 uint32_t trr_value;
346 struct {
347 #define TRR_FAULT_NONE 0
348 #define TRR_FAULT_PENDING 1
349 #define TRR_FAULT_OBSERVED 2
350 /*
351 * Set to TRR_FAULT_PENDING with interrupts disabled
352 * by the thread when it is entering a user fault codepath.
353 *
354 * Moved to TRR_FAULT_OBSERVED from TRR_FAULT_PENDING:
355 * - by the thread if at IPI time,
356 * - or by task_restartable_ranges_synchronize() if the thread
357 * is interrupted (under the thread lock)
358 *
359 * Cleared by the thread when returning from a user fault
360 * codepath.
361 */
362 uint8_t trr_fault_state;
363
364 /*
365 * Set by task_restartable_ranges_synchronize()
366 * if trr_fault_state is TRR_FAULT_OBSERVED
367 * and a rendez vous at the AST is required.
368 *
369 * Set atomically if trr_fault_state == TRR_FAULT_OBSERVED,
370 * and trr_ipi_ack_pending == 0
371 */
372 uint8_t trr_sync_waiting;
373
374 /*
375 * Updated under the thread_lock(),
376 * set by task_restartable_ranges_synchronize()
377 * when the thread was IPIed and the caller is waiting
378 * for an ACK.
379 */
380 uint16_t trr_ipi_ack_pending;
381 };
382 } thread_rr_state_t;
383
384 struct thread {
385 #if MACH_ASSERT
386 #define THREAD_MAGIC 0x1234ABCDDCBA4321ULL
387 /* Ensure nothing uses &thread as a queue entry */
388 uint64_t thread_magic;
389 #endif /* MACH_ASSERT */
390
391 /*
392 * NOTE: The runq field in the thread structure has an unusual
393 * locking protocol. If its value is PROCESSOR_NULL, then it is
394 * locked by the thread_lock, but if its value is something else
395 * then it is locked by the associated run queue lock. It is
396 * set to PROCESSOR_NULL without holding the thread lock, but the
397 * transition from PROCESSOR_NULL to non-null must be done
398 * under the thread lock and the run queue lock. To enforce the
399 * protocol, runq should only be accessed using the
400 * thread_get/set/clear_runq functions and locked variants below.
401 *
402 * New waitq APIs allow the 'links' and '__runq' fields to be
403 * anywhere in the thread structure.
404 */
405 union {
406 queue_chain_t runq_links; /* run queue links */
407 queue_chain_t wait_links; /* wait queue links */
408 struct mpsc_queue_chain mpsc_links; /* thread daemon mpsc links */
409 struct priority_queue_entry_sched wait_prioq_links; /* priority ordered waitq links */
410 };
411
412 event64_t wait_event; /* wait queue event */
413 struct { processor_t runq; } __runq; /* internally managed run queue assignment, see above comment */
414 waitq_t waitq; /* wait queue this thread is enqueued on */
415 struct turnstile *turnstile; /* thread's turnstile, protected by primitives interlock */
416 void *inheritor; /* inheritor of the primitive the thread will block on */
417 struct priority_queue_sched_max sched_inheritor_queue; /* Inheritor queue for kernel promotion */
418 struct priority_queue_sched_max base_inheritor_queue; /* Inheritor queue for user promotion */
419
420 #if CONFIG_SCHED_EDGE
421 bool th_bound_cluster_enqueued;
422 bool th_shared_rsrc_enqueued[CLUSTER_SHARED_RSRC_TYPE_COUNT];
423 bool th_shared_rsrc_heavy_user[CLUSTER_SHARED_RSRC_TYPE_COUNT];
424 bool th_shared_rsrc_heavy_perf_control[CLUSTER_SHARED_RSRC_TYPE_COUNT];
425 #endif /* CONFIG_SCHED_EDGE */
426
427 #if CONFIG_SCHED_CLUTCH
428 /*
429 * In the clutch scheduler, the threads are maintained in runqs at the clutch_bucket
430 * level (clutch_bucket defines a unique thread group and scheduling bucket pair). The
431 * thread is linked via a couple of linkages in the clutch bucket:
432 *
433 * - A stable priority queue linkage which is the main runqueue (based on sched_pri) for the clutch bucket
434 * - A regular priority queue linkage which is based on thread's base/promoted pri (used for clutch bucket priority calculation)
435 * - A queue linkage used for timesharing operations of threads at the scheduler tick
436 */
437 struct priority_queue_entry_stable th_clutch_runq_link;
438 struct priority_queue_entry_sched th_clutch_pri_link;
439 queue_chain_t th_clutch_timeshare_link;
440 #endif /* CONFIG_SCHED_CLUTCH */
441
442 /* Data updated during assert_wait/thread_wakeup */
443 decl_simple_lock_data(, sched_lock); /* scheduling lock (thread_lock()) */
444 decl_simple_lock_data(, wake_lock); /* for thread stop / wait (wake_lock()) */
445 uint16_t options; /* options set by thread itself */
446 #define TH_OPT_INTMASK 0x0003 /* interrupt / abort level */
447 #define TH_OPT_VMPRIV 0x0004 /* may allocate reserved memory */
448 #define TH_OPT_SYSTEM_CRITICAL 0x0010 /* Thread must always be allowed to run - even under heavy load */
449 #define TH_OPT_PROC_CPULIMIT 0x0020 /* Thread has a task-wide CPU limit applied to it */
450 #define TH_OPT_PRVT_CPULIMIT 0x0040 /* Thread has a thread-private CPU limit applied to it */
451 #define TH_OPT_IDLE_THREAD 0x0080 /* Thread is a per-processor idle thread */
452 #define TH_OPT_GLOBAL_FORCED_IDLE 0x0100 /* Thread performs forced idle for thermal control */
453 #define TH_OPT_SCHED_VM_GROUP 0x0200 /* Thread belongs to special scheduler VM group */
454 #define TH_OPT_HONOR_QLIMIT 0x0400 /* Thread will honor qlimit while sending mach_msg, regardless of MACH_SEND_ALWAYS */
455 #define TH_OPT_SEND_IMPORTANCE 0x0800 /* Thread will allow importance donation from kernel rpc */
456 #define TH_OPT_ZONE_PRIV 0x1000 /* Thread may use the zone replenish reserve */
457 #define TH_OPT_IPC_TG_BLOCKED 0x2000 /* Thread blocked in sync IPC and has made the thread group blocked callout */
458 #define TH_OPT_FORCED_LEDGER 0x4000 /* Thread has a forced CPU limit */
459 #define TH_IN_MACH_EXCEPTION 0x8000 /* Thread is currently handling a mach exception */
460
461 bool wake_active; /* wake event on stop */
462 bool at_safe_point; /* thread_abort_safely allowed */
463 uint8_t sched_saved_run_weight;
464 #if DEVELOPMENT || DEBUG
465 bool pmap_footprint_suspended;
466 #endif /* DEVELOPMENT || DEBUG */
467
468
469 ast_t reason; /* why we blocked */
470 uint32_t quantum_remaining;
471 wait_result_t wait_result; /* outcome of wait -
472 * may be examined by this thread
473 * WITHOUT locking */
474 thread_rr_state_t t_rr_state; /* state for restartable ranges */
475 thread_continue_t continuation; /* continue here next dispatch */
476 void *parameter; /* continuation parameter */
477
478 /* Data updated/used in thread_invoke */
479 vm_offset_t kernel_stack; /* current kernel stack */
480 vm_offset_t reserved_stack; /* reserved kernel stack */
481
482 /*** Machine-dependent state ***/
483 struct machine_thread machine;
484
485 #if KASAN
486 struct kasan_thread_data kasan_data;
487 #endif
488 #if CONFIG_KCOV
489 kcov_thread_data_t kcov_data;
490 #endif
491
492 /* Thread state: */
493 int state;
494 /*
495 * Thread states [bits or'ed]
496 * All but TH_WAIT_REPORT are encoded in SS_TH_FLAGS
497 * All are encoded in kcdata.py ('ths_state')
498 */
499 #define TH_WAIT 0x01 /* queued for waiting */
500 #define TH_SUSP 0x02 /* stopped or requested to stop */
501 #define TH_RUN 0x04 /* running or on runq */
502 #define TH_UNINT 0x08 /* waiting uninteruptibly */
503 #define TH_TERMINATE 0x10 /* halted at termination */
504 #define TH_TERMINATE2 0x20 /* added to termination queue */
505 #define TH_WAIT_REPORT 0x40 /* the wait is using the sched_call,
506 * only set if TH_WAIT is also set */
507 #define TH_IDLE 0x80 /* idling processor */
508 #define TH_WAKING 0x100 /* between waitq remove and thread_go */
509
510 /* Scheduling information */
511 sched_mode_t sched_mode; /* scheduling mode */
512 sched_mode_t saved_mode; /* saved mode during forced mode demotion */
513
514 /* This thread's contribution to global sched counters */
515 sched_bucket_t th_sched_bucket;
516
517 sfi_class_id_t sfi_class; /* SFI class (XXX Updated on CSW/QE/AST) */
518 sfi_class_id_t sfi_wait_class; /* Currently in SFI wait for this class, protected by sfi_lock */
519
520 uint32_t sched_flags; /* current flag bits */
521 #if CONFIG_SCHED_SMT
522 #define TH_SFLAG_NO_SMT 0x0001 /* On an SMT CPU, this thread must be scheduled alone */
523 #endif /* CONFIG_SCHED_SMT */
524
525 #define TH_SFLAG_FAILSAFE 0x0002 /* fail-safe has tripped */
526 #define TH_SFLAG_THROTTLED 0x0004 /* throttled thread forced to timeshare mode (may be applied in addition to failsafe) */
527
528 /* unused TH_SFLAG_PROMOTED 0x0008 */
529 #define TH_SFLAG_ABORT 0x0010 /* abort interruptible waits */
530 #define TH_SFLAG_ABORTSAFELY 0x0020 /* ... but only those at safe point */
531 #define TH_SFLAG_ABORTED_MASK (TH_SFLAG_ABORT | TH_SFLAG_ABORTSAFELY)
532 #define TH_SFLAG_DEPRESS 0x0040 /* normal depress yield */
533 #define TH_SFLAG_POLLDEPRESS 0x0080 /* polled depress yield */
534 #define TH_SFLAG_DEPRESSED_MASK (TH_SFLAG_DEPRESS | TH_SFLAG_POLLDEPRESS)
535 /* unused TH_SFLAG_PRI_UPDATE 0x0100 */
536 #define TH_SFLAG_EAGERPREEMPT 0x0200 /* Any preemption of this thread should be treated as if AST_URGENT applied */
537 #define TH_SFLAG_RW_PROMOTED 0x0400 /* promote reason: blocking with RW lock held */
538 #define TH_SFLAG_BASE_PRI_FROZEN 0x0800 /* (effective) base_pri is frozen */
539 #define TH_SFLAG_WAITQ_PROMOTED 0x1000 /* promote reason: waitq wakeup (generally for IPC receive) */
540
541 #if __AMP__
542 /* unused TH_SFLAG_ECORE_ONLY 0x2000 */
543 /* unused TH_SFLAG_PCORE_ONLY 0x4000 */
544 #endif
545
546 #define TH_SFLAG_EXEC_PROMOTED 0x8000 /* promote reason: thread is in an exec */
547
548 #define TH_SFLAG_THREAD_GROUP_AUTO_JOIN 0x10000 /* thread has been auto-joined to thread group */
549 #if __AMP__
550 /* unused TH_SFLAG_BOUND_SOFT 0x20000 */
551 #endif /* __AMP__ */
552
553 #if CONFIG_PREADOPT_TG
554 #define TH_SFLAG_REEVALUTE_TG_HIERARCHY_LATER 0x40000 /* thread needs to reevaluate its TG hierarchy */
555 #endif
556
557 #define TH_SFLAG_FLOOR_PROMOTED 0x80000 /* promote reason: boost requested */
558
559 /* 'promote reasons' that request a priority floor only, not a custom priority */
560 #define TH_SFLAG_PROMOTE_REASON_MASK (TH_SFLAG_RW_PROMOTED | TH_SFLAG_WAITQ_PROMOTED | TH_SFLAG_EXEC_PROMOTED | TH_SFLAG_FLOOR_PROMOTED)
561
562 #define TH_SFLAG_RT_DISALLOWED 0x100000 /* thread wants RT but may not have joined a work interval that allows it */
563 #define TH_SFLAG_DEMOTED_MASK (TH_SFLAG_THROTTLED | TH_SFLAG_FAILSAFE | TH_SFLAG_RT_DISALLOWED) /* saved_mode contains previous sched_mode */
564 #define TH_SFLAG_RT_CPULIMIT 0x200000 /* thread should have a CPU limit applied. */
565
566 #define TH_SFLAG_FAILSAFE_REPORTED 0x400000 /* whether the kernel has already logged that thread triggered the failsafe (to prevent log spam) */
567
568 int16_t sched_pri; /* scheduled (current) priority */
569 int16_t base_pri; /* effective base priority (equal to req_base_pri unless TH_SFLAG_BASE_PRI_FROZEN) */
570 int16_t req_base_pri; /* requested base priority */
571 int16_t max_priority; /* copy of max base priority */
572 int16_t task_priority; /* copy of task base priority */
573 uint16_t priority_floor_count; /* number of push to boost the floor priority */
574 int16_t suspend_count; /* Kernel holds on this thread */
575
576 int iotier_override; /* atomic operations to set, cleared on ret to user */
577 os_ref_atomic_t ref_count; /* number of references to me */
578
579 uint32_t rwlock_count; /* Number of lck_rw_t locks held by thread */
580 struct smrq_slist_head smr_stack;
581 #ifdef DEBUG_RW
582 rw_lock_debug_t rw_lock_held; /* rw_locks currently held by the thread */
583 #endif /* DEBUG_RW */
584
585 integer_t importance; /* task-relative importance */
586
587 /* Priority depression expiration */
588 integer_t depress_timer_active;
589 timer_call_t depress_timer;
590
591 /* real-time parameters */
592 struct { /* see mach/thread_policy.h */
593 uint32_t period;
594 uint32_t computation;
595 uint32_t constraint;
596 bool preemptible;
597 uint8_t priority_offset; /* base_pri = BASEPRI_RTQUEUES + priority_offset */
598 uint64_t deadline;
599 } realtime;
600
601 uint64_t last_run_time; /* time when thread was switched away from */
602 uint64_t last_made_runnable_time; /* time when thread was unblocked or preempted */
603 uint64_t last_basepri_change_time; /* time when thread was last changed in basepri while runnable */
604 uint64_t same_pri_latency;
605 /*
606 * workq_quantum_deadline is the workq thread's next runtime deadline. This
607 * value is set to 0 if the thread has no such deadline applicable to it.
608 *
609 * The synchronization for this field is due to how this field is modified
610 * 1) This field is always modified on the thread by itself or on the thread
611 * when it is not running/runnable
612 * 2) Change of this field is immediately followed by a
613 * corresponding change to the AST_KEVENT to either set or clear the
614 * AST_KEVENT_WORKQ_QUANTUM_EXPIRED bit
615 *
616 * workq_quantum_deadline can be modified by the thread on itself during
617 * interrupt context. However, due to (2) and due to the fact that the
618 * change to the AST_KEVENT is volatile, this forces the compiler to
619 * guarantee the order between the write to workq_quantum_deadline and the
620 * kevent field and therefore guarantees the correct synchronization.
621 */
622 uint64_t workq_quantum_deadline;
623
624 #if WORKQ_QUANTUM_HISTORY_DEBUG
625
626 #define WORKQ_QUANTUM_HISTORY_COUNT 16
627 struct workq_quantum_history {
628 uint64_t time;
629 uint64_t deadline;
630 bool arm;
631 } workq_quantum_history[WORKQ_QUANTUM_HISTORY_COUNT];
632 uint64_t workq_quantum_history_index;
633
634 #define WORKQ_QUANTUM_HISTORY_WRITE_ENTRY(thread, ...) ({\
635 thread_t __th = (thread); \
636 uint64_t __index = os_atomic_inc_orig(&thread->workq_quantum_history_index, relaxed); \
637 struct workq_quantum_history _wq_quantum_history = { mach_approximate_time(), __VA_ARGS__}; \
638 __th->workq_quantum_history[__index % WORKQ_QUANTUM_HISTORY_COUNT] = \
639 (struct workq_quantum_history) _wq_quantum_history; \
640 })
641 #else /* WORKQ_QUANTUM_HISTORY_DEBUG */
642 #define WORKQ_QUANTUM_HISTORY_WRITE_ENTRY(thread, ...)
643 #endif /* WORKQ_QUANTUM_HISTORY_DEBUG */
644
645 #define THREAD_NOT_RUNNABLE (~0ULL)
646
647 #if CONFIG_THREAD_GROUPS
648 struct thread_group *thread_group;
649 #endif
650
651 /* Data used during setrun/dispatch */
652 processor_t bound_processor; /* bound to a processor? */
653 processor_t last_processor; /* processor last dispatched on */
654 processor_t chosen_processor; /* Where we want to run this thread */
655
656 /* Fail-safe computation since last unblock or qualifying yield */
657 uint64_t computation_metered;
658 uint64_t computation_epoch;
659 uint64_t computation_interrupt_epoch;
660 uint64_t safe_release; /* when to release fail-safe */
661
662 /* Call out from scheduler */
663 void (*sched_call)(int type, thread_t thread);
664
665 /* Statistics and timesharing calculations */
666 #if defined(CONFIG_SCHED_TIMESHARE_CORE)
667 natural_t sched_stamp; /* last scheduler tick */
668 natural_t sched_usage; /* timesharing cpu usage [sched] */
669 natural_t pri_shift; /* usage -> priority from pset */
670 natural_t cpu_usage; /* instrumented cpu usage [%cpu] */
671 natural_t cpu_delta; /* accumulated cpu_usage delta */
672 #endif /* CONFIG_SCHED_TIMESHARE_CORE */
673
674 uint32_t c_switch; /* total context switches */
675 uint32_t p_switch; /* total processor switches */
676 uint32_t ps_switch; /* total pset switches */
677
678 /* Timing data structures */
679 uint64_t sched_time_save; /* saved time for scheduler tick */
680 uint64_t vtimer_user_save; /* saved values for vtimers */
681 uint64_t vtimer_prof_save;
682 uint64_t vtimer_rlim_save;
683 uint64_t vtimer_qos_save;
684
685 timer_data_t runnable_timer; /* time the thread is runnable (including running) */
686
687 struct recount_thread th_recount; /* resource accounting */
688
689 #if CONFIG_SCHED_SFI
690 /* Timing for wait state */
691 uint64_t wait_sfi_begin_time; /* start time for thread waiting in SFI */
692 #endif
693
694 /*
695 * Processor/cache affinity
696 * - affinity_threads links task threads with the same affinity set
697 */
698 queue_chain_t affinity_threads;
699 affinity_set_t affinity_set;
700
701 #if CONFIG_TASKWATCH
702 task_watch_t *taskwatch; /* task watch */
703 #endif /* CONFIG_TASKWATCH */
704
705 /* Various bits of state to stash across a continuation, exclusive to the current thread block point */
706 union {
707 struct {
708 /* set before ipc_mqueue_receive() as implicit arguments */
709 mach_msg_recv_bufs_t recv_bufs; /* receive context */
710 mach_msg_option64_t option; /* 64 bits options for receive */
711 ipc_object_t object; /* object received on */
712
713 /* set by ipc_mqueue_receive() as implicit results */
714 mach_msg_return_t state; /* receive state */
715 mach_port_seqno_t seqno; /* seqno of recvd message */
716 mach_msg_size_t msize; /* actual size for the msg */
717 mach_msg_size_t asize; /* actual size for aux data */
718 mach_port_name_t receiver_name; /* the receive port name */
719 union {
720 struct ipc_kmsg *XNU_PTRAUTH_SIGNED_PTR("thread.ith_kmsg") kmsg; /* received message */
721 #if MACH_FLIPC
722 struct ipc_mqueue *XNU_PTRAUTH_SIGNED_PTR("thread.ith_peekq") peekq; /* mqueue to peek at */
723 #endif /* MACH_FLIPC */
724 };
725 } receive;
726 struct {
727 struct semaphore *waitsemaphore; /* semaphore ref */
728 struct semaphore *signalsemaphore; /* semaphore ref */
729 int options; /* semaphore options */
730 kern_return_t result; /* primary result */
731 mach_msg_continue_t continuation;
732 } sema;
733 struct {
734 #define THREAD_SAVE_IOKIT_TLS_COUNT 8
735 void *tls[THREAD_SAVE_IOKIT_TLS_COUNT];
736 } iokit;
737 } saved;
738
739 /* Only user threads can cause Mach exceptions, only kernel threads can be thread call threads */
740 union {
741 /* Thread call thread's state structure, stored on its stack */
742 struct thread_call_thread_state *thc_state;
743
744 /* Structure to save information about Mach exception */
745 struct {
746 int os_reason;
747 exception_type_t exception_type;
748 mach_exception_code_t code;
749 mach_exception_subcode_t subcode;
750 } mach_exc_info;
751 };
752
753 /* User level suspensions */
754 int32_t user_stop_count;
755
756 /* IPC data structures */
757 #if IMPORTANCE_INHERITANCE
758 natural_t ith_assertions; /* assertions pending drop */
759 #endif
760 circle_queue_head_t ith_messages; /* messages to reap */
761 mach_port_t ith_kernel_reply_port; /* reply port for kernel RPCs */
762
763 /* VM Fault Tolerance */
764 bool th_vm_faults_disabled;
765
766 /* Ast/Halt data structures */
767 bool recover; /* True if page faulted in recoverable IO */
768
769 #if DEBUG || DEVELOPMENT
770 struct thread_test_context *th_test_ctx; /* thread-specific data for kernel tests */
771 #endif
772
773 queue_chain_t threads; /* global list of all threads */
774
775 /* Activation */
776 queue_chain_t task_threads;
777
778 /* Task membership */
779 #if __x86_64__ || __arm__
780 struct task *t_task;
781 #endif
782 struct thread_ro *t_tro;
783 vm_map_t map;
784 thread_t handoff_thread;
785
786 /* Timed wait expiration */
787 timer_call_t wait_timer;
788 uint16_t wait_timer_active; /* is the call running */
789 bool wait_timer_armed; /* should the wait be cleared */
790
791 /* Miscellaneous bits guarded by mutex */
792 uint32_t
793 active:1, /* Thread is active and has not been terminated */
794 ipc_active:1, /* IPC with the thread ports is allowed */
795 started:1, /* Thread has been started after creation */
796 static_param:1, /* Disallow policy parameter changes */
797 inspection:1, /* TRUE when task is being inspected by crash reporter */
798 policy_reset:1, /* Disallow policy parameter changes on terminating threads */
799 suspend_parked:1, /* thread parked in thread_suspended */
800 corpse_dup:1, /* TRUE when thread is an inactive duplicate in a corpse */
801 :0;
802
803 /* Pending thread ast(s) */
804 os_atomic(ast_t) ast;
805
806 decl_lck_mtx_data(, mutex);
807
808 struct ipc_port *ith_special_reply_port; /* ref to special reply port */
809
810 #if CONFIG_DTRACE
811 uint16_t t_dtrace_flags; /* DTrace thread states */
812 #define TH_DTRACE_EXECSUCCESS 0x01
813 uint16_t t_dtrace_inprobe; /* Executing under dtrace_probe */
814 uint32_t t_dtrace_predcache; /* DTrace per thread predicate value hint */
815 int64_t t_dtrace_tracing; /* Thread time under dtrace_probe() */
816 int64_t t_dtrace_vtime;
817 #endif
818
819 clock_sec_t t_page_creation_time;
820 uint32_t t_page_creation_count;
821 uint32_t t_page_creation_throttled;
822 #if (DEVELOPMENT || DEBUG)
823 uint64_t t_page_creation_throttled_hard;
824 uint64_t t_page_creation_throttled_soft;
825 #endif /* DEVELOPMENT || DEBUG */
826 int t_pagein_error; /* for vm_fault(), holds error from vnop_pagein() */
827
828 mach_port_name_t ith_voucher_name;
829 ipc_voucher_t ith_voucher;
830
831 #ifdef KPERF
832 /* The high 8 bits are the number of frames to sample of a user callstack. */
833 #define T_KPERF_CALLSTACK_DEPTH_OFFSET (24)
834 #define T_KPERF_SET_CALLSTACK_DEPTH(DEPTH) (((uint32_t)(DEPTH)) << T_KPERF_CALLSTACK_DEPTH_OFFSET)
835 #define T_KPERF_GET_CALLSTACK_DEPTH(FLAGS) ((FLAGS) >> T_KPERF_CALLSTACK_DEPTH_OFFSET)
836 #define T_KPERF_ACTIONID_OFFSET (18)
837 #define T_KPERF_SET_ACTIONID(AID) (((uint32_t)(AID)) << T_KPERF_ACTIONID_OFFSET)
838 #define T_KPERF_GET_ACTIONID(FLAGS) ((FLAGS) >> T_KPERF_ACTIONID_OFFSET)
839 #endif
840
841 #define T_KPERF_AST_CALLSTACK 0x1 /* dump a callstack on thread's next AST */
842 #define T_KPERF_AST_DISPATCH 0x2 /* dump a name on thread's next AST */
843 #define T_KPC_ALLOC 0x4 /* thread needs a kpc_buf allocated */
844
845 #define T_KPERF_AST_ALL \
846 (T_KPERF_AST_CALLSTACK | T_KPERF_AST_DISPATCH | T_KPC_ALLOC)
847 /* only go up to T_KPERF_ACTIONID_OFFSET - 1 */
848
849 #ifdef KPERF
850 uint32_t kperf_ast;
851 uint32_t kperf_pet_gen; /* last generation of PET that sampled this thread*/
852 uint32_t kperf_c_switch; /* last dispatch detection */
853 uint32_t kperf_pet_cnt; /* how many times a thread has been sampled by PET */
854 #if CONFIG_EXCLAVES
855 uint32_t kperf_exclaves_ast;
856 #endif
857 #endif
858
859 #ifdef CONFIG_CPU_COUNTERS
860 /* accumulated performance counters for this thread */
861 uint64_t *kpc_buf;
862 #endif /* CONFIG_CPU_COUNTERS */
863
864 #if HYPERVISOR
865 /* hypervisor virtual CPU object associated with this thread */
866 void *hv_thread_target;
867 #endif /* HYPERVISOR */
868
869 /* Statistics accumulated per-thread and aggregated per-task */
870 uint32_t syscalls_unix;
871 uint32_t syscalls_mach;
872 ledger_t t_ledger;
873 ledger_t t_threadledger; /* per thread ledger */
874 ledger_t t_bankledger; /* ledger to charge someone */
875 uint64_t t_deduct_bank_ledger_time; /* cpu time to be deducted from bank ledger */
876 uint64_t t_deduct_bank_ledger_energy; /* energy to be deducted from bank ledger */
877
878 uint64_t thread_id; /* system wide unique thread-id */
879 uint32_t ctid; /* system wide compact thread-id */
880 uint32_t ctsid; /* this thread ts ID */
881
882 /* policy is protected by the thread mutex */
883 struct thread_requested_policy requested_policy;
884 struct thread_effective_policy effective_policy;
885
886 /* usynch override is protected by the task lock, eventually will be thread mutex */
887 struct thread_qos_override {
888 struct thread_qos_override *override_next;
889 uint32_t override_contended_resource_count;
890 int16_t override_qos;
891 int16_t override_resource_type;
892 user_addr_t override_resource;
893 } *overrides;
894
895 uint32_t kevent_overrides;
896 uint8_t user_promotion_basepri;
897 uint8_t kern_promotion_schedpri;
898 _Atomic uint16_t kevent_ast_bits;
899
900 io_stat_info_t thread_io_stats; /* per-thread I/O statistics */
901
902 uint32_t thread_callout_interrupt_wakeups;
903 uint32_t thread_callout_platform_idle_wakeups;
904 uint32_t thread_timer_wakeups_bin_1;
905 uint32_t thread_timer_wakeups_bin_2;
906 thread_tag_t thread_tag;
907
908 /*
909 * callout_* fields are only set for thread call threads whereas mach_exc_* are set
910 * by user threads on themselves while taking a Mach exception. So it's okay for them to
911 * share this bitfield.
912 */
913 uint16_t
914 callout_woken_from_icontext:1,
915 callout_woken_from_platform_idle:1,
916 callout_woke_thread:1,
917 mach_exc_fatal:1,
918 mach_exc_ktriage:1,
919 thread_bitfield_unused:11;
920
921 #define THREAD_BOUND_CLUSTER_NONE (UINT32_MAX)
922 /*
923 * Cluster to which the thread is soft-bound for scheduling. The thread will always run
924 * on its bound cluster unless that cluster has been derecommended for scheduling.
925 */
926 uint32_t th_bound_cluster_id;
927
928 #if CONFIG_THREAD_GROUPS
929 #if CONFIG_PREADOPT_TG
930 /* The preadopt thread group is set on the thread
931 *
932 * a) By another thread when it is a creator and it is scheduled with the
933 * thread group on the TR
934 * b) On itself when it binds a thread request and becomes a
935 * servicer or when it rebinds to the thread request
936 * c) On itself when it processes knotes and finds the first
937 * EVFILT_MACHPORT event to deliver to userspace
938 *
939 * Note that this is a full reference owned by the thread_t and not a
940 * borrowed reference.
941 *
942 * This reference is cleared from the thread_t by the thread itself at the
943 * following times:
944 * a) When it explicitly adopts a work interval or a bank voucher
945 * b) If it still exists on the thread, after it has unbound and is about
946 * to park
947 * c) During thread termination if one still exists
948 * d) When a different preadoption thread group is set on the thread
949 *
950 * It is modified under the thread lock.
951 */
952 struct thread_group *preadopt_thread_group;
953
954 /* This field here is present in order to make sure that the t->thread_group
955 * is always pointing to a valid thread group and isn't a dangling pointer.
956 *
957 * Consider the following scenario:
958 * a) t->thread_group points to the preadoption thread group
959 * b) The preadoption thread group is modified on the thread but we are
960 * unable to resolve the hierarchy immediately due to the current state of
961 * the thread
962 *
963 * In order to make sure that t->thread_group points to a valid thread
964 * group until we can resolve the hierarchy again, we save the existing
965 * thread_group it points to in old_preadopt_thread_group. The next time a
966 * hierarchy resolution is done, we know that t->thread_group will not point
967 * to this field anymore so we can clear it.
968 *
969 * This field is always going to take the reference that was previously in
970 * preadopt_thread_group so it will have a full +1
971 */
972 struct thread_group *old_preadopt_thread_group;
973 #endif /* CONFIG_PREADOPT_TG */
974
975 /* This is a borrowed reference to the TG from the ith_voucher and is saved
976 * here since we may not always be in the right context to able to do the
977 * lookups.
978 *
979 * It is set always set on self under the thread lock */
980 struct thread_group *bank_thread_group;
981
982 /* Whether this is the autojoin thread group or the work interval thread
983 * group depends on whether the thread's sched_flags has the
984 * TH_SFLAG_THREAD_GROUP_AUTO_JOIN bit set */
985 union {
986 /* This is a borrowed reference to the auto join thread group from the
987 * work_interval. It is set with the thread lock held */
988 struct thread_group *auto_join_thread_group;
989 /* This is a borrowed reference to the explicit work_interval thread group
990 * and is always set on self */
991 struct thread_group *work_interval_thread_group;
992 };
993 #endif /* CONFIG_THREAD_GROUPS */
994
995 /* work interval (if any) associated with the thread. Only modified by
996 * current thread on itself or when another thread when the thread is held
997 * off of runq */
998 struct work_interval *th_work_interval;
999 thread_work_interval_flags_t th_work_interval_flags;
1000
1001 #if SCHED_TRACE_THREAD_WAKEUPS
1002 uintptr_t thread_wakeup_bt[64];
1003 #endif
1004 turnstile_update_flags_t inheritor_flags; /* inheritor flags for inheritor field */
1005 block_hint_t pending_block_hint;
1006 block_hint_t block_hint; /* What type of primitive last caused us to block. */
1007 uint32_t decompressions; /* Per-thread decompressions counter to be added to per-task decompressions counter */
1008 int thread_region_page_shift; /* Page shift that this thread would like to use when */
1009 /* introspecting a task. This is currently being used */
1010 /* by footprint which uses a thread for each task being inspected. */
1011 #if CONFIG_SCHED_RT_ALLOW
1012 /* Used when a thread is requested to set/clear its own CPU limit */
1013 uint32_t
1014 t_ledger_req_action:2,
1015 t_ledger_req_percentage:7,
1016 t_ledger_req_interval_ms:16,
1017 :0;
1018 #endif /* CONFIG_SCHED_RT_ALLOW */
1019
1020 #if CONFIG_IOSCHED
1021 void *decmp_upl;
1022 #endif /* CONFIG_IOSCHED */
1023 struct knote *ith_knote; /* knote fired for rcv */
1024
1025 #if CONFIG_SPTM
1026 /* TXM thread stack associated with this thread */
1027 uintptr_t txm_thread_stack;
1028 #endif
1029
1030 #if CONFIG_EXCLAVES
1031 /* Per-thread IPC context for exclaves communication. Only modified by the
1032 * current thread on itself. */
1033 exclaves_ctx_t th_exclaves_ipc_ctx;
1034 /* Thread exclaves interrupt-safe state. Only mutated by the current thread
1035 * on itself with interrupts disabled, and only ever read by the current
1036 * thread (with no locking), including from interrupt context, or during
1037 * debug/stackshot. */
1038 thread_exclaves_intstate_flags_t th_exclaves_intstate;
1039 /* Thread exclaves state. Only mutated by the current thread on itself, and
1040 * only ever read by the current thread (with no locking). Unsafe to read
1041 * from interrupt context. */
1042 thread_exclaves_state_flags_t th_exclaves_state;
1043 /* Thread stackshot state. Prevents returning to Exclave world until after
1044 * an external agent has triggered inspection (likely via Exclave stackshot),
1045 * and woken this thread. */
1046 thread_exclaves_inspection_flags_t _Atomic th_exclaves_inspection_state;
1047 /* Task for which conclave teardown is being called by this thread. Used
1048 * for context by conclave crash info upcall to find the task for appending
1049 * the conclave crash info. */
1050 task_t conclave_stop_task;
1051 /* Queue of threads being inspected by Stackshot.
1052 * Modified under exclaves_collect_mtx. */
1053 queue_chain_t th_exclaves_inspection_queue_stackshot;
1054 /* Queue of threads being inspected by kperf.
1055 * Modified under exclaves_collect_mtx. */
1056 queue_chain_t th_exclaves_inspection_queue_kperf;
1057 #endif /* CONFIG_EXCLAVES */
1058 };
1059
1060 #define ith_receive saved.receive
1061 /* arguments */
1062 #define ith_recv_bufs saved.receive.recv_bufs
1063 #define ith_object saved.receive.object
1064 #define ith_option saved.receive.option
1065 /* results */
1066 #define ith_state saved.receive.state
1067 #define ith_seqno saved.receive.seqno
1068 #define ith_msize saved.receive.msize
1069 #define ith_asize saved.receive.asize
1070 #define ith_receiver_name saved.receive.receiver_name
1071 #define ith_kmsg saved.receive.kmsg
1072 #if MACH_FLIPC
1073 #define ith_peekq saved.receive.peekq
1074 #endif /* MACH_FLIPC */
1075
1076 #define sth_waitsemaphore saved.sema.waitsemaphore
1077 #define sth_signalsemaphore saved.sema.signalsemaphore
1078 #define sth_options saved.sema.options
1079 #define sth_result saved.sema.result
1080 #define sth_continuation saved.sema.continuation
1081
1082 #define ITH_KNOTE_NULL ((void *)NULL)
1083 #define ITH_KNOTE_PSEUDO ((void *)0xdeadbeef)
1084 /*
1085 * The ith_knote is used during message delivery, and can safely be interpreted
1086 * only when used for one of these codepaths, which the test for the msgt_name
1087 * being RECEIVE or SEND_ONCE is about.
1088 */
1089 #define ITH_KNOTE_VALID(kn, msgt_name) \
1090 (((kn) != ITH_KNOTE_NULL && (kn) != ITH_KNOTE_PSEUDO) && \
1091 ((msgt_name) == MACH_MSG_TYPE_PORT_RECEIVE || \
1092 (msgt_name) == MACH_MSG_TYPE_PORT_SEND_ONCE))
1093
1094 #if MACH_ASSERT
1095 #define assert_thread_magic(thread) assertf((thread)->thread_magic == THREAD_MAGIC, \
1096 "bad thread magic 0x%llx for thread %p, expected 0x%llx", \
1097 (thread)->thread_magic, (thread), THREAD_MAGIC)
1098 #else
1099 #define assert_thread_magic(thread) do { (void)(thread); } while (0)
1100 #endif
1101
1102 extern thread_t thread_bootstrap(void);
1103
1104 extern void thread_machine_init_template(void);
1105
1106 extern void thread_init(void);
1107
1108 extern void thread_daemon_init(void);
1109
1110 extern void thread_reference(
1111 thread_t thread);
1112
1113 extern void thread_deallocate(
1114 thread_t thread);
1115
1116 extern void thread_inspect_deallocate(
1117 thread_inspect_t thread);
1118
1119 extern void thread_read_deallocate(
1120 thread_read_t thread);
1121
1122 extern kern_return_t thread_terminate(
1123 thread_t thread);
1124
1125 extern void thread_terminate_self(void);
1126
1127 extern kern_return_t thread_terminate_internal(
1128 thread_t thread);
1129
1130 extern void thread_start(
1131 thread_t thread) __attribute__ ((noinline));
1132
1133 extern void thread_start_in_assert_wait(
1134 thread_t thread,
1135 struct waitq *waitq,
1136 event64_t event,
1137 wait_interrupt_t interruptible) __attribute__ ((noinline));
1138
1139 extern void thread_terminate_enqueue(
1140 thread_t thread);
1141
1142 extern void thread_exception_enqueue(
1143 task_t task,
1144 thread_t thread,
1145 exception_type_t etype);
1146
1147 extern void thread_backtrace_enqueue(
1148 kcdata_object_t obj,
1149 exception_port_t ports[static BT_EXC_PORTS_COUNT],
1150 exception_type_t etype);
1151
1152 extern void thread_copy_resource_info(
1153 thread_t dst_thread,
1154 thread_t src_thread);
1155
1156 extern void thread_terminate_crashed_threads(void);
1157
1158 extern void thread_stack_enqueue(
1159 thread_t thread);
1160
1161 extern void thread_hold(
1162 thread_t thread);
1163
1164 extern void thread_release(
1165 thread_t thread);
1166
1167 extern void thread_corpse_continue(void) __dead2;
1168
1169 extern boolean_t thread_is_active(thread_t thread);
1170
1171 extern lck_grp_t thread_lck_grp;
1172
1173 /* Locking for scheduler state, always acquired with interrupts disabled (splsched()) */
1174 #define thread_lock_init(th) simple_lock_init(&(th)->sched_lock, 0)
1175 #define thread_lock(th) simple_lock(&(th)->sched_lock, &thread_lck_grp)
1176 #define thread_unlock(th) simple_unlock(&(th)->sched_lock)
1177 #define thread_lock_assert(th, x) simple_lock_assert(&(th)->sched_lock, (x))
1178
1179 #define wake_lock_init(th) simple_lock_init(&(th)->wake_lock, 0)
1180 #define wake_lock(th) simple_lock(&(th)->wake_lock, &thread_lck_grp)
1181 #define wake_unlock(th) simple_unlock(&(th)->wake_lock)
1182
1183 #define thread_should_halt_fast(thread) (!(thread)->active)
1184
1185 extern void stack_alloc(
1186 thread_t thread);
1187
1188 extern void stack_handoff(
1189 thread_t from,
1190 thread_t to);
1191
1192 extern void stack_free(
1193 thread_t thread);
1194
1195 extern void stack_free_reserved(
1196 thread_t thread);
1197
1198 extern boolean_t stack_alloc_try(
1199 thread_t thread);
1200
1201 extern void stack_collect(void);
1202
1203 extern kern_return_t thread_info_internal(
1204 thread_t thread,
1205 thread_flavor_t flavor,
1206 thread_info_t thread_info_out,
1207 mach_msg_type_number_t *thread_info_count);
1208
1209 extern kern_return_t kernel_thread_create(
1210 thread_continue_t continuation,
1211 void *parameter,
1212 integer_t priority,
1213 thread_t *new_thread);
1214
1215 extern kern_return_t kernel_thread_start_priority(
1216 thread_continue_t continuation,
1217 void *parameter,
1218 integer_t priority,
1219 thread_t *new_thread);
1220
1221 extern void machine_stack_attach(
1222 thread_t thread,
1223 vm_offset_t stack);
1224
1225 extern vm_offset_t machine_stack_detach(
1226 thread_t thread);
1227
1228 extern void machine_stack_handoff(
1229 thread_t old,
1230 thread_t new);
1231
1232 extern thread_t machine_switch_context(
1233 thread_t old_thread,
1234 thread_continue_t continuation,
1235 thread_t new_thread);
1236
1237 extern void machine_load_context(
1238 thread_t thread) __attribute__((noreturn));
1239
1240 extern void machine_thread_state_initialize(
1241 thread_t thread);
1242
1243 extern kern_return_t machine_thread_set_state(
1244 thread_t thread,
1245 thread_flavor_t flavor,
1246 thread_state_t state,
1247 mach_msg_type_number_t count);
1248
1249 extern mach_vm_address_t machine_thread_pc(
1250 thread_t thread);
1251
1252 extern void machine_thread_reset_pc(
1253 thread_t thread,
1254 mach_vm_address_t pc);
1255
1256 extern boolean_t machine_thread_on_core(
1257 thread_t thread);
1258
1259 extern boolean_t machine_thread_on_core_allow_invalid(
1260 thread_t thread);
1261
1262 extern kern_return_t machine_thread_get_state(
1263 thread_t thread,
1264 thread_flavor_t flavor,
1265 thread_state_t state,
1266 mach_msg_type_number_t *count);
1267
1268 extern kern_return_t machine_thread_state_convert_from_user(
1269 thread_t thread,
1270 thread_flavor_t flavor,
1271 thread_state_t tstate,
1272 mach_msg_type_number_t count,
1273 thread_state_t old_tstate,
1274 mach_msg_type_number_t old_count,
1275 thread_set_status_flags_t tssf_flags);
1276
1277 extern kern_return_t machine_thread_state_convert_to_user(
1278 thread_t thread,
1279 thread_flavor_t flavor,
1280 thread_state_t tstate,
1281 mach_msg_type_number_t *count,
1282 thread_set_status_flags_t tssf_flags);
1283
1284 extern kern_return_t machine_thread_dup(
1285 thread_t self,
1286 thread_t target,
1287 boolean_t is_corpse);
1288
1289 extern void machine_thread_init(void);
1290
1291 extern void machine_thread_template_init(thread_t thr_template);
1292
1293 #if __has_feature(ptrauth_calls)
1294 extern bool machine_thread_state_is_debug_flavor(int flavor);
1295 #endif /* __has_feature(ptrauth_calls) */
1296
1297
1298 extern void machine_thread_create(
1299 thread_t thread,
1300 task_t task,
1301 bool first_thread);
1302
1303 extern kern_return_t machine_thread_process_signature(
1304 thread_t thread,
1305 task_t task);
1306
1307 extern void machine_thread_switch_addrmode(
1308 thread_t thread);
1309
1310 extern void machine_thread_destroy(
1311 thread_t thread);
1312
1313 extern void machine_set_current_thread(
1314 thread_t thread);
1315
1316 extern kern_return_t machine_thread_get_kern_state(
1317 thread_t thread,
1318 thread_flavor_t flavor,
1319 thread_state_t tstate,
1320 mach_msg_type_number_t *count);
1321
1322 extern kern_return_t machine_thread_inherit_taskwide(
1323 thread_t thread,
1324 task_t parent_task);
1325
1326 extern kern_return_t machine_thread_set_tsd_base(
1327 thread_t thread,
1328 mach_vm_offset_t tsd_base);
1329
1330 #define thread_mtx_try(thread) lck_mtx_try_lock(&(thread)->mutex)
1331 #define thread_mtx_held(thread) lck_mtx_assert(&(thread)->mutex, LCK_MTX_ASSERT_OWNED)
1332
1333 extern void thread_apc_ast(thread_t thread);
1334
1335 extern void thread_update_qos_cpu_time(thread_t thread);
1336
1337 void act_machine_sv_free(thread_t, int);
1338
1339 vm_offset_t min_valid_stack_address(void);
1340 vm_offset_t max_valid_stack_address(void);
1341
1342 #if CONFIG_SCHED_SMT
1343 extern bool thread_no_smt(thread_t thread);
1344 extern bool processor_active_thread_no_smt(processor_t processor);
1345 #endif /* CONFIG_SCHED_SMT */
1346
1347 extern void thread_set_options(uint32_t thopt);
1348
1349 #if CONFIG_THREAD_GROUPS
1350 struct thread_group *thread_get_current_voucher_thread_group(thread_t thread);
1351 #endif /* CONFIG_THREAD_GROUPS */
1352
1353 #if CONFIG_COALITIONS
1354 uint64_t thread_get_current_voucher_resource_coalition_id(thread_t thread);
1355 #endif /* CONFIG_COALITIONS */
1356
1357 #endif /* MACH_KERNEL_PRIVATE */
1358 #if BSD_KERNEL_PRIVATE
1359
1360 /* Duplicated from osfmk/kern/ipc_tt.h */
1361 __options_decl(port_intrans_options_t, uint32_t, {
1362 PORT_INTRANS_OPTIONS_NONE = 0x0000,
1363 PORT_INTRANS_THREAD_IN_CURRENT_TASK = 0x0001,
1364 PORT_INTRANS_THREAD_NOT_CURRENT_THREAD = 0x0002,
1365
1366 PORT_INTRANS_SKIP_TASK_EVAL = 0x0004,
1367 PORT_INTRANS_ALLOW_CORPSE_TASK = 0x0008,
1368 });
1369
1370 extern thread_t port_name_to_thread(
1371 mach_port_name_t port_name,
1372 port_intrans_options_t options);
1373
1374 #endif /* BSD_KERNEL_PRIVATE */
1375 #ifdef XNU_KERNEL_PRIVATE
1376
1377 extern void thread_require(
1378 thread_t thread);
1379
1380 extern void thread_deallocate_safe(
1381 thread_t thread);
1382
1383 extern uint64_t thread_rettokern_addr(
1384 thread_t thread);
1385
1386 extern uint64_t thread_wqquantum_addr(
1387 thread_t thread);
1388
1389 extern integer_t thread_kern_get_pri(thread_t thr) __pure2;
1390
1391 extern void thread_kern_set_pri(thread_t thr, integer_t pri);
1392
1393 extern integer_t thread_kern_get_kernel_maxpri(void) __pure2;
1394
1395 uint16_t thread_set_tag(thread_t thread, uint16_t tag);
1396 uint16_t thread_get_tag(thread_t thread);
1397
1398 __options_decl(shared_rsrc_policy_agent_t, uint32_t, {
1399 SHARED_RSRC_POLICY_AGENT_DISPATCH = 0,
1400 SHARED_RSRC_POLICY_AGENT_SYSCTL = 1,
1401 SHARED_RSRC_POLICY_AGENT_PERFCTL_CSW = 2,
1402 SHARED_RSRC_POLICY_AGENT_PERFCTL_QUANTUM = 3,
1403 });
1404
1405 boolean_t thread_shared_rsrc_policy_get(thread_t thread, cluster_shared_rsrc_type_t type);
1406 kern_return_t thread_shared_rsrc_policy_set(thread_t thread, uint32_t index, cluster_shared_rsrc_type_t type, shared_rsrc_policy_agent_t agent);
1407 kern_return_t thread_shared_rsrc_policy_clear(thread_t thread, cluster_shared_rsrc_type_t type, shared_rsrc_policy_agent_t agent);
1408
1409 #ifdef MACH_KERNEL_PRIVATE
1410 static inline thread_tag_t
thread_set_tag_internal(thread_t thread,thread_tag_t tag)1411 thread_set_tag_internal(thread_t thread, thread_tag_t tag)
1412 {
1413 return os_atomic_or_orig(&thread->thread_tag, tag, relaxed);
1414 }
1415
1416 static inline thread_tag_t
thread_get_tag_internal(thread_t thread)1417 thread_get_tag_internal(thread_t thread)
1418 {
1419 return thread->thread_tag;
1420 }
1421 #endif /* MACH_KERNEL_PRIVATE */
1422
1423 uint64_t thread_last_run_time(thread_t thread);
1424
1425 extern kern_return_t thread_state_initialize(
1426 thread_t thread);
1427
1428 extern kern_return_t thread_setstatus(
1429 thread_t thread,
1430 int flavor,
1431 thread_state_t tstate,
1432 mach_msg_type_number_t count);
1433
1434 extern kern_return_t thread_setstatus_from_user(
1435 thread_t thread,
1436 int flavor,
1437 thread_state_t tstate,
1438 mach_msg_type_number_t count,
1439 thread_state_t old_tstate,
1440 mach_msg_type_number_t old_count,
1441 thread_set_status_flags_t flags);
1442
1443 extern kern_return_t thread_getstatus(
1444 thread_t thread,
1445 int flavor,
1446 thread_state_t tstate,
1447 mach_msg_type_number_t *count);
1448
1449 extern void main_thread_set_immovable_pinned(thread_t thread);
1450
1451 extern kern_return_t thread_getstatus_to_user(
1452 thread_t thread,
1453 int flavor,
1454 thread_state_t tstate,
1455 mach_msg_type_number_t *count,
1456 thread_set_status_flags_t flags);
1457
1458 extern kern_return_t thread_create_with_continuation(
1459 task_t task,
1460 thread_t *new_thread,
1461 thread_continue_t continuation);
1462
1463 extern kern_return_t main_thread_create_waiting(task_t task,
1464 thread_continue_t continuation,
1465 event_t event,
1466 thread_t *new_thread);
1467
1468 extern kern_return_t thread_create_workq_waiting(
1469 task_t task,
1470 thread_continue_t thread_return,
1471 thread_t *new_thread,
1472 bool is_permanently_bound);
1473
1474 extern void thread_yield_internal(
1475 mach_msg_timeout_t interval);
1476
1477 extern void thread_yield_to_preemption(void);
1478
1479 extern void thread_depress_timer_setup(thread_t self);
1480
1481 /*
1482 * Thread-private CPU limits: apply a private CPU limit to this thread only. Available actions are:
1483 *
1484 * 1) Block. Prevent CPU consumption of the thread from exceeding the limit.
1485 * 2) Exception. Generate a resource consumption exception when the limit is exceeded.
1486 * 3) Disable. Remove any existing CPU limit.
1487 */
1488 #define THREAD_CPULIMIT_BLOCK 0x1
1489 #define THREAD_CPULIMIT_EXCEPTION 0x2
1490 #define THREAD_CPULIMIT_DISABLE 0x3
1491
1492 struct _thread_ledger_indices {
1493 int cpu_time;
1494 };
1495
1496 extern struct _thread_ledger_indices thread_ledgers;
1497
1498 extern int thread_get_cpulimit(int *action, uint8_t *percentage, uint64_t *interval_ns);
1499 extern int thread_set_cpulimit(int action, uint8_t percentage, uint64_t interval_ns);
1500
1501 extern uint64_t thread_cpulimit_remaining(uint64_t now);
1502 extern bool thread_cpulimit_interval_has_expired(uint64_t now);
1503 extern void thread_cpulimit_restart(uint64_t now);
1504
1505 extern void thread_read_times(
1506 thread_t thread,
1507 time_value_t *user_time,
1508 time_value_t *system_time,
1509 time_value_t *runnable_time);
1510
1511 extern void thread_read_times_unsafe(
1512 thread_t thread,
1513 time_value_t *user_time,
1514 time_value_t *system_time,
1515 time_value_t *runnable_time);
1516
1517 extern uint64_t thread_get_runtime_self(void);
1518
1519 extern void thread_setuserstack(
1520 thread_t thread,
1521 mach_vm_offset_t user_stack);
1522
1523 extern user_addr_t thread_adjuserstack(
1524 thread_t thread,
1525 int adjust);
1526
1527
1528 extern void thread_setentrypoint(
1529 thread_t thread,
1530 mach_vm_offset_t entry);
1531
1532 extern kern_return_t thread_set_tsd_base(
1533 thread_t thread,
1534 mach_vm_offset_t tsd_base);
1535
1536 extern kern_return_t thread_setsinglestep(
1537 thread_t thread,
1538 int on);
1539
1540 extern kern_return_t thread_userstack(
1541 thread_t,
1542 int,
1543 thread_state_t,
1544 unsigned int,
1545 mach_vm_offset_t *,
1546 int *,
1547 boolean_t);
1548
1549 extern kern_return_t thread_entrypoint(
1550 thread_t,
1551 int,
1552 thread_state_t,
1553 unsigned int,
1554 mach_vm_offset_t *);
1555
1556 extern kern_return_t thread_userstackdefault(
1557 mach_vm_offset_t *,
1558 boolean_t);
1559
1560 extern kern_return_t thread_wire_internal(
1561 host_priv_t host_priv,
1562 thread_t thread,
1563 boolean_t wired,
1564 boolean_t *prev_state);
1565
1566
1567 extern kern_return_t thread_dup(thread_t);
1568
1569 extern kern_return_t thread_dup2(thread_t, thread_t);
1570
1571 #if !defined(_SCHED_CALL_T_DEFINED)
1572 #define _SCHED_CALL_T_DEFINED
1573 typedef void (*sched_call_t)(
1574 int type,
1575 thread_t thread);
1576 #endif
1577
1578 #define SCHED_CALL_BLOCK 0x1
1579 #define SCHED_CALL_UNBLOCK 0x2
1580
1581 extern void thread_sched_call(
1582 thread_t thread,
1583 sched_call_t call);
1584
1585 extern boolean_t thread_is_static_param(
1586 thread_t thread);
1587
1588 extern task_t get_threadtask(thread_t) __pure2;
1589
1590 extern task_t get_threadtask_early(thread_t) __pure2;
1591
1592 /*
1593 * Thread is running within a 64-bit address space.
1594 */
1595 #define thread_is_64bit_addr(thd) \
1596 task_has_64Bit_addr(get_threadtask(thd))
1597
1598 /*
1599 * Thread is using 64-bit machine state.
1600 */
1601 #define thread_is_64bit_data(thd) \
1602 task_has_64Bit_data(get_threadtask(thd))
1603
1604 struct uthread;
1605
1606 #if defined(__x86_64__)
1607 extern int thread_task_has_ldt(thread_t);
1608 #endif
1609 extern void set_thread_pagein_error(thread_t, int);
1610 extern event_t workq_thread_init_and_wq_lock(task_t, thread_t); // bsd/pthread/
1611
1612 struct proc;
1613 struct uthread;
1614 struct image_params;
1615 extern const size_t uthread_size;
1616 extern thread_ro_t get_thread_ro_unchecked(thread_t) __pure2;
1617 extern thread_ro_t get_thread_ro(thread_t) __pure2;
1618 extern thread_ro_t current_thread_ro_unchecked(void) __pure2;
1619 extern thread_ro_t current_thread_ro(void) __pure2;
1620 extern void clear_thread_ro_proc(thread_t);
1621 extern struct uthread *get_bsdthread_info(thread_t) __pure2;
1622 extern thread_t get_machthread(struct uthread *) __pure2;
1623 extern uint64_t uthread_tid(struct uthread *) __pure2;
1624 extern user_addr_t thread_get_sigreturn_token(thread_t thread);
1625 extern uint32_t thread_get_sigreturn_diversifier(thread_t thread);
1626 extern void uthread_init(task_t, struct uthread *, thread_ro_t, int);
1627 extern void uthread_cleanup_name(struct uthread *uthread);
1628 extern void uthread_cleanup(struct uthread *, thread_ro_t);
1629 extern void uthread_cred_ref(struct ucred *);
1630 extern void uthread_cred_free(struct ucred *);
1631 extern void uthread_destroy(struct uthread *);
1632 extern void uthread_reset_proc_refcount(struct uthread *);
1633
1634 extern void uthread_set_exec_data(struct uthread *uth, struct image_params *imgp);
1635 extern bool uthread_is64bit(struct uthread *uth) __pure2;
1636 #if PROC_REF_DEBUG
1637 extern void uthread_init_proc_refcount(struct uthread *);
1638 extern void uthread_destroy_proc_refcount(struct uthread *);
1639 extern void uthread_assert_zero_proc_refcount(struct uthread *);
1640 #else
1641 #define uthread_init_proc_refcount(uth) ((void)(uth))
1642 #define uthread_destroy_proc_refcount(uth) ((void)(uth))
1643 #define uthread_assert_zero_proc_refcount(uth) ((void)(uth))
1644 #endif
1645 #if CONFIG_DEBUG_SYSCALL_REJECTION
1646 extern uint64_t uthread_get_syscall_rejection_flags(void *);
1647 extern uint64_t *uthread_get_syscall_rejection_mask(void *);
1648 extern uint64_t *uthread_get_syscall_rejection_once_mask(void *);
1649 extern bool uthread_syscall_rejection_is_enabled(void *);
1650 #endif /* CONFIG_DEBUG_SYSCALL_REJECTION */
1651 extern mach_port_name_t uthread_joiner_port(struct uthread *);
1652 extern user_addr_t uthread_joiner_address(struct uthread *);
1653 extern void uthread_joiner_wake(task_t task, struct uthread *);
1654
1655 extern boolean_t thread_should_halt(
1656 thread_t thread);
1657
1658 extern boolean_t thread_should_abort(
1659 thread_t);
1660
1661 extern bool current_thread_in_kernel_fault(void);
1662
1663 extern int is_64signalregset(void);
1664
1665 extern void act_set_kperf(thread_t);
1666 extern void act_set_astledger(thread_t thread);
1667 extern void act_set_astledger_async(thread_t thread);
1668 extern void act_set_io_telemetry_ast(thread_t);
1669 extern void act_set_macf_telemetry_ast(thread_t);
1670 extern void act_set_astproc_resource(thread_t);
1671
1672 extern vm_offset_t thread_get_kernel_stack(thread_t);
1673
1674 extern kern_return_t thread_process_signature(thread_t thread, task_t task);
1675
1676 extern uint32_t dtrace_get_thread_predcache(thread_t);
1677 extern int64_t dtrace_get_thread_vtime(thread_t);
1678 extern int64_t dtrace_get_thread_tracing(thread_t);
1679 extern uint16_t dtrace_get_thread_inprobe(thread_t);
1680 extern int dtrace_get_thread_last_cpu_id(thread_t);
1681 extern vm_offset_t dtrace_get_kernel_stack(thread_t);
1682 #define dtrace_get_kernel_stack thread_get_kernel_stack
1683 extern void dtrace_set_thread_predcache(thread_t, uint32_t);
1684 extern void dtrace_set_thread_vtime(thread_t, int64_t);
1685 extern void dtrace_set_thread_tracing(thread_t, int64_t);
1686 extern void dtrace_set_thread_inprobe(thread_t, uint16_t);
1687 extern void dtrace_thread_bootstrap(void);
1688 extern void dtrace_thread_didexec(thread_t);
1689
1690 extern int64_t dtrace_calc_thread_recent_vtime(thread_t);
1691
1692
1693 extern kern_return_t thread_set_wq_state32(
1694 thread_t thread,
1695 thread_state_t tstate);
1696
1697 extern kern_return_t thread_set_wq_state64(
1698 thread_t thread,
1699 thread_state_t tstate);
1700
1701 extern vm_offset_t kernel_stack_mask;
1702 extern vm_offset_t kernel_stack_size;
1703 extern vm_offset_t kernel_stack_depth_max;
1704
1705 extern void mach_exception_ast(thread_t);
1706 extern void fd_guard_ast(thread_t,
1707 mach_exception_code_t, mach_exception_subcode_t);
1708 extern void vn_guard_ast(thread_t,
1709 mach_exception_code_t, mach_exception_subcode_t);
1710 extern void mach_port_guard_ast(thread_t,
1711 mach_exception_code_t, mach_exception_subcode_t);
1712 extern void virt_memory_guard_ast(thread_t,
1713 mach_exception_code_t, mach_exception_subcode_t);
1714 extern void thread_ast_mach_exception(thread_t,
1715 int, exception_type_t, mach_exception_code_t, mach_exception_subcode_t, bool, bool);
1716 extern void thread_guard_violation(thread_t,
1717 mach_exception_code_t, mach_exception_subcode_t, bool);
1718 extern void thread_update_io_stats(thread_t, int size, int io_flags);
1719
1720 extern kern_return_t thread_set_voucher_name(mach_port_name_t name);
1721 extern kern_return_t thread_get_voucher_origin_pid(thread_t thread, int32_t *pid);
1722 extern kern_return_t thread_get_voucher_origin_proximate_pid(thread_t thread,
1723 int32_t *origin_pid, int32_t *proximate_pid);
1724 extern kern_return_t thread_get_current_voucher_origin_pid(int32_t *pid);
1725
1726 extern void thread_enable_send_importance(thread_t thread, boolean_t enable);
1727
1728 /*
1729 * Translate signal context data pointer to userspace representation
1730 */
1731
1732 extern kern_return_t machine_thread_siguctx_pointer_convert_to_user(
1733 thread_t thread,
1734 user_addr_t *uctxp);
1735
1736 extern void machine_tecs(thread_t thr);
1737
1738 typedef enum cpuvn {
1739 CPUVN_CI = 1
1740 } cpuvn_e;
1741
1742 extern int machine_csv(cpuvn_e cve);
1743 #if defined(__x86_64__)
1744 extern void machine_thread_set_insn_copy_optout(thread_t thr);
1745 #endif
1746
1747 /*
1748 * Translate array of function pointer syscall arguments from userspace representation
1749 */
1750
1751 extern kern_return_t machine_thread_function_pointers_convert_from_user(
1752 thread_t thread,
1753 user_addr_t *fptrs,
1754 uint32_t count);
1755
1756 /*
1757 * Get the duration of the given thread's last wait.
1758 */
1759 uint64_t thread_get_last_wait_duration(thread_t thread);
1760
1761 #if CONFIG_SCHED_SMT
1762 extern bool thread_get_no_smt(void);
1763 #endif /* CONFIG_SCHED_SMT */
1764 #if defined(__x86_64__)
1765 extern bool curtask_get_insn_copy_optout(void);
1766 extern void curtask_set_insn_copy_optout(void);
1767 #endif /* defined(__x86_64__) */
1768
1769 /*! @function ctid_get_thread
1770 * @abstract translates a ctid_t to thread_t
1771 * @discussion ctid are system wide compact thread-id
1772 * associated to thread_t at thread creation
1773 * and recycled at thread termination. If a ctid is
1774 * referenced past the corresponding thread termination,
1775 * it is considered stale, and the behavior is not defined.
1776 * Note that this call does not acquire a reference on the thread,
1777 * so as soon as the matching thread terminates, the ctid
1778 * will become stale, and it could be re-used and associated with
1779 * another thread. You must externally guarantee that the thread
1780 * will not exit while you are using its ctid.
1781 * @result thread_t corresponding to ctid
1782 */
1783 extern thread_t ctid_get_thread(ctid_t ctid);
1784
1785 /*! @function ctid_get_thread
1786 * @abstract translates a ctid_t to thread_t
1787 * @discussion Unsafe variant of ctid_get_thread() to be used
1788 * when the caller can't guarantee the liveness of this ctid_t.
1789 * may return NULL or a freed thread_t.
1790 */
1791 extern thread_t ctid_get_thread_unsafe(ctid_t ctid);
1792
1793 /*!
1794 * @function thread_get_ctid
1795 * @abstract returns the ctid of thread.
1796 * @param thread to find the corresponding ctid.
1797 * @discussion the ctid provided will become stale after the matching thread
1798 * terminates.
1799 * @result uint32_t ctid.
1800 */
1801 extern ctid_t thread_get_ctid(thread_t thread);
1802
1803 #endif /* XNU_KERNEL_PRIVATE */
1804 #ifdef KERNEL_PRIVATE
1805
1806 typedef struct thread_pri_floor {
1807 thread_t thread;
1808 } thread_pri_floor_t;
1809
1810 #ifdef MACH_KERNEL_PRIVATE
1811 extern void thread_floor_boost_ast(thread_t thread);
1812 extern void thread_floor_boost_set_promotion_locked(thread_t thread);
1813 #endif /* MACH_KERNEL_PRIVATE */
1814
1815 /*! @function thread_priority_floor_start
1816 * @abstract boost the current thread priority to floor.
1817 * @discussion Increase the priority of the current thread to at least MINPRI_FLOOR.
1818 * The boost will be mantained until a corresponding thread_priority_floor_end()
1819 * is called. Every call of thread_priority_floor_start() needs to have a corresponding
1820 * call to thread_priority_floor_end() from the same thread.
1821 * No thread can return to userspace before calling thread_priority_floor_end().
1822 *
1823 * NOTE: avoid to use this function. Try to use gate_t or sleep_with_inheritor()
1824 * instead.
1825 * @result a token to be given to the corresponding thread_priority_floor_end()
1826 */
1827 extern thread_pri_floor_t thread_priority_floor_start(void);
1828 /*! @function thread_priority_floor_end
1829 * @abstract ends the floor boost.
1830 * @param token the token obtained from thread_priority_floor_start()
1831 * @discussion ends the priority floor boost started with thread_priority_floor_start()
1832 */
1833 extern void thread_priority_floor_end(thread_pri_floor_t *token);
1834
1835 #if defined(__x86_64__)
1836 extern void thread_set_no_smt(bool set);
1837 #endif /* __x86_64__ */
1838
1839 extern void thread_mtx_lock(thread_t thread);
1840
1841 extern void thread_mtx_unlock(thread_t thread);
1842
1843 extern uint64_t thread_dispatchqaddr(
1844 thread_t thread);
1845
1846 bool thread_is_eager_preempt(thread_t thread);
1847 void thread_set_eager_preempt(thread_t thread);
1848 void thread_clear_eager_preempt(thread_t thread);
1849 void thread_set_honor_qlimit(thread_t thread);
1850 void thread_clear_honor_qlimit(thread_t thread);
1851 extern ipc_port_t convert_thread_to_port(thread_t);
1852 extern ipc_port_t convert_thread_to_port_pinned(thread_t);
1853 extern ipc_port_t convert_thread_inspect_to_port(thread_inspect_t);
1854 extern ipc_port_t convert_thread_read_to_port(thread_read_t);
1855 extern void convert_thread_array_to_ports(thread_act_array_t, size_t, mach_thread_flavor_t);
1856 extern boolean_t is_external_pageout_thread(void);
1857 extern boolean_t is_vm_privileged(void);
1858 extern boolean_t set_vm_privilege(boolean_t);
1859 extern kern_allocation_name_t thread_set_allocation_name(kern_allocation_name_t new_name);
1860 extern void *thread_iokit_tls_get(uint32_t index);
1861 extern void thread_iokit_tls_set(uint32_t index, void * data);
1862 extern int thread_self_region_page_shift(void);
1863 extern void thread_self_region_page_shift_set(int pgshift);
1864 extern kern_return_t thread_create_immovable(task_t task, thread_t *new_thread);
1865 extern kern_return_t thread_terminate_pinned(thread_t thread);
1866
1867 struct thread_attr_for_ipc_propagation;
1868 extern kern_return_t thread_get_ipc_propagate_attr(thread_t thread, struct thread_attr_for_ipc_propagation *attr);
1869 extern size_t thread_get_current_exec_path(char *path, size_t size);
1870 #endif /* KERNEL_PRIVATE */
1871 #ifdef XNU_KERNEL_PRIVATE
1872
1873 extern void
1874 thread_get_thread_name(thread_t th, char* name);
1875
1876 /* Read the runq assignment, under the thread lock. */
1877 extern processor_t thread_get_runq(thread_t thread);
1878
1879 /*
1880 * Read the runq assignment, under both the thread lock and
1881 * the pset lock corresponding to the last non-null assignment.
1882 */
1883 extern processor_t thread_get_runq_locked(thread_t thread);
1884
1885 /*
1886 * Set the runq assignment to a non-null value, under both the
1887 * thread lock and the pset lock corresponding to the new
1888 * assignment.
1889 */
1890 extern void thread_set_runq_locked(thread_t thread, processor_t new_runq);
1891
1892 /*
1893 * Set the runq assignment to PROCESSOR_NULL, under the pset
1894 * lock corresponding to the current non-null assignment.
1895 */
1896 extern void thread_clear_runq(thread_t thread);
1897
1898 /*
1899 * Set the runq assignment to PROCESSOR_NULL, under both the
1900 * thread lock and the pset lock corresponding to the current
1901 * non-null assignment.
1902 */
1903 extern void thread_clear_runq_locked(thread_t thread);
1904
1905 /*
1906 * Assert the runq assignment to be PROCESSOR_NULL, under
1907 * some guarantee that the runq will not change from null to
1908 * non-null, such as holding the thread lock.
1909 */
1910 extern void thread_assert_runq_null(thread_t thread);
1911
1912 /*
1913 * Assert the runq assignment to be non-null, under the pset
1914 * lock corresponding to the current non-null assignment.
1915 */
1916 extern void thread_assert_runq_nonnull(thread_t thread);
1917
1918 extern bool thread_supports_cooperative_workqueue(thread_t thread);
1919 extern void thread_arm_workqueue_quantum(thread_t thread);
1920 extern void thread_disarm_workqueue_quantum(thread_t thread);
1921
1922 extern void thread_evaluate_workqueue_quantum_expiry(thread_t thread);
1923 extern bool thread_has_expired_workqueue_quantum(thread_t thread, bool should_trace);
1924
1925 #if CONFIG_SPTM
1926
1927 extern void
1928 thread_associate_txm_thread_stack(uintptr_t thread_stack);
1929
1930 extern void
1931 thread_disassociate_txm_thread_stack(uintptr_t thread_stack);
1932
1933 extern uintptr_t
1934 thread_get_txm_thread_stack(void);
1935
1936 #endif /* CONFIG_SPTM */
1937
1938 /* Kernel side prototypes for MIG routines */
1939 extern kern_return_t thread_get_exception_ports(
1940 thread_t thread,
1941 exception_mask_t exception_mask,
1942 exception_mask_array_t masks,
1943 mach_msg_type_number_t *CountCnt,
1944 exception_port_array_t ports,
1945 exception_behavior_array_t behaviors,
1946 thread_state_flavor_array_t flavors);
1947
1948 extern kern_return_t thread_get_special_port(
1949 thread_inspect_t thread,
1950 int which,
1951 ipc_port_t *portp);
1952
1953 #endif /* XNU_KERNEL_PRIVATE */
1954
1955 /*! @function thread_has_thread_name
1956 * @abstract Checks if a thread has a name.
1957 * @discussion This function takes one input, a thread, and returns
1958 * a boolean value indicating if that thread already has a name associated
1959 * with it.
1960 * @param th The thread to inspect.
1961 * @result TRUE if the thread has a name, FALSE otherwise.
1962 */
1963 extern boolean_t thread_has_thread_name(thread_t th);
1964
1965 /*! @function thread_set_thread_name
1966 * @abstract Set a thread's name.
1967 * @discussion This function takes two input parameters: a thread to name,
1968 * and the name to apply to the thread. The name will be copied over to
1969 * the thread in order to better identify the thread. If the name is
1970 * longer than MAXTHREADNAMESIZE - 1, it will be truncated.
1971 * @param th The thread to be named.
1972 * @param name The name to apply to the thread.
1973 */
1974 extern void thread_set_thread_name(thread_t th, const char* name);
1975
1976 #if !MACH_KERNEL_PRIVATE || !defined(current_thread)
1977 extern thread_t current_thread(void) __pure2;
1978 #endif
1979
1980
1981 extern uint64_t thread_tid(thread_t thread) __pure2;
1982
1983 extern void thread_reference(
1984 thread_t thread);
1985
1986 extern void thread_deallocate(
1987 thread_t thread);
1988
1989 /*! @function kernel_thread_start
1990 * @abstract Create a kernel thread.
1991 * @discussion This function takes three input parameters, namely reference
1992 * to the function that the thread should execute, caller specified data
1993 * and a reference which is used to return the newly created kernel
1994 * thread. The function returns KERN_SUCCESS on success or an appropriate
1995 * kernel code type indicating the error. It may be noted that the caller
1996 * is responsible for explicitly releasing the reference to the created
1997 * thread when no longer needed. This should be done by calling
1998 * thread_deallocate(new_thread).
1999 * @param continuation A C-function pointer where the thread will begin execution.
2000 * @param parameter Caller specified data to be passed to the new thread.
2001 * @param new_thread Reference to the new thread is returned in this parameter.
2002 * @result Returns KERN_SUCCESS on success or an appropriate kernel code type.
2003 */
2004
2005 extern kern_return_t kernel_thread_start(
2006 thread_continue_t continuation,
2007 void *parameter,
2008 thread_t *new_thread);
2009
2010 __END_DECLS
2011
2012 #endif /* _KERN_THREAD_H_ */
2013