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