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