xref: /xnu-12377.41.6/osfmk/kern/task.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
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 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:	task.h
60  *	Author:	Avadis Tevanian, Jr.
61  *
62  *	This file contains the structure definitions for tasks.
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  * NOTICE: This file was modified by McAfee Research in 2004 to introduce
85  * support for mandatory and extensible security protections.  This notice
86  * is included in support of clause 2.2 (b) of the Apple Public License,
87  * Version 2.0.
88  * Copyright (c) 2005 SPARTA, Inc.
89  */
90 
91 #ifndef _KERN_TASK_H_
92 #define _KERN_TASK_H_
93 
94 #include <kern/kern_types.h>
95 #include <kern/task_ref.h>
96 #include <mach/mach_types.h>
97 #include <sys/cdefs.h>
98 
99 #ifdef XNU_KERNEL_PRIVATE
100 #include <kern/btlog.h>
101 #include <kern/kern_cdata.h>
102 #include <mach/sfi_class.h>
103 #include <kern/counter.h>
104 #include <kern/cs_blobs.h>
105 #include <kern/queue.h>
106 #include <kern/recount.h>
107 #include <sys/kern_sysctl.h>
108 #include <sys/resource_private.h>
109 
110 #if CONFIG_EXCLAVES
111 #include <mach/exclaves.h>
112 #endif /* CONFIG_EXCLAVES */
113 #endif /* XNU_KERNEL_PRIVATE */
114 
115 #ifdef  MACH_KERNEL_PRIVATE
116 #include <mach/boolean.h>
117 #include <mach/port.h>
118 #include <mach/time_value.h>
119 #include <mach/message.h>
120 #include <mach/mach_param.h>
121 #include <mach/task_info.h>
122 #include <mach/exception_types.h>
123 #include <mach/vm_statistics.h>
124 #include <machine/task.h>
125 
126 #include <kern/cpu_data.h>
127 #include <kern/queue.h>
128 #include <kern/exception.h>
129 #include <kern/locks.h>
130 #include <security/_label.h>
131 #include <ipc/ipc_port.h>
132 
133 #include <kern/thread.h>
134 #include <mach/coalition.h>
135 #include <stdatomic.h>
136 #include <os/refcnt.h>
137 
138 #if CONFIG_DEFERRED_RECLAIM
139 typedef struct vm_deferred_reclamation_metadata_s *vm_deferred_reclamation_metadata_t;
140 #endif /* CONFIG_DEFFERED_RECLAIM */
141 
142 struct _cpu_time_qos_stats {
143 	uint64_t cpu_time_qos_default;
144 	uint64_t cpu_time_qos_maintenance;
145 	uint64_t cpu_time_qos_background;
146 	uint64_t cpu_time_qos_utility;
147 	uint64_t cpu_time_qos_legacy;
148 	uint64_t cpu_time_qos_user_initiated;
149 	uint64_t cpu_time_qos_user_interactive;
150 };
151 
152 struct task_writes_counters {
153 	uint64_t task_immediate_writes;
154 	uint64_t task_deferred_writes;
155 	uint64_t task_invalidated_writes;
156 	uint64_t task_metadata_writes;
157 };
158 
159 struct task_pend_token {
160 	union {
161 		struct {
162 			uint32_t        tpt_update_sockets      :1,
163 			    tpt_update_timers       :1,
164 			    tpt_update_watchers     :1,
165 			    tpt_update_live_donor   :1,
166 			    tpt_update_coal_sfi     :1,
167 			    tpt_update_throttle     :1,
168 			    tpt_update_thread_sfi   :1,
169 			    tpt_force_recompute_pri :1,
170 			    tpt_update_tg_ui_flag   :1,
171 			    tpt_update_turnstile    :1,
172 			    tpt_update_tg_app_flag  :1,
173 			    tpt_update_game_mode    :1,
174 			    tpt_update_carplay_mode :1,
175 			    tpt_update_appnap       :1;
176 		};
177 		uint32_t tpt_value;
178 	};
179 };
180 
181 typedef struct task_pend_token task_pend_token_s;
182 typedef struct task_pend_token *task_pend_token_t;
183 
184 struct task_security_config {
185 	union {
186 		struct {
187 			uint8_t hardened_heap: 1,
188 			    tpro :1,
189 #if HAS_MTE || HAS_MTE_EMULATION_SHIMS
190 			    sec :1,
191 #else /* HAS_MTE || HAS_MTE_EMULATION_SHIMS */
192 			reserved: 1,
193 #endif
194 			platform_restrictions_version :3;
195 			uint8_t hardened_process_version;
196 		};
197 		uint16_t value;
198 	};
199 };
200 
201 typedef struct task_security_config task_security_config_s;
202 
203 struct task_watchports;
204 #include <bank/bank_internal.h>
205 
206 struct ucred;
207 
208 #ifdef MACH_BSD
209 struct proc;
210 struct proc_ro;
211 #endif
212 
213 __options_closed_decl(task_memlimit_flags_t, uint32_t, {
214 	/* if set, use active attributes, otherwise use inactive attributes */
215 	TASK_MEMLIMIT_IS_ACTIVE             = 0x01,
216 	/* if set, exceeding current memlimit will prove fatal to the task */
217 	TASK_MEMLIMIT_IS_FATAL              = 0x02,
218 	/* if set, suppress exc_resource exception when task exceeds active memory limit */
219 	TASK_MEMLIMIT_ACTIVE_EXC_RESOURCE   = 0x04,
220 	/* if set, suppress exc_resource exception when task exceeds inactive memory limit */
221 	TASK_MEMLIMIT_INACTIVE_EXC_RESOURCE = 0x08
222 });
223 
224 struct task {
225 	/* Synchronization/destruction information */
226 	decl_lck_mtx_data(, lock);      /* Task's lock */
227 	os_refcnt_t     ref_count;      /* Number of references to me */
228 
229 #if DEVELOPMENT || DEBUG
230 	struct os_refgrp *ref_group;
231 	lck_spin_t        ref_group_lock;
232 #endif /* DEVELOPMENT || DEBUG */
233 
234 	bool            active;         /* Task has not been terminated */
235 	bool            ipc_active;     /* IPC with the task ports is allowed */
236 	bool            halting;        /* Task is being halted */
237 	bool            message_app_suspended;  /* Let iokit know when pidsuspended */
238 
239 	/* Virtual timers */
240 	uint32_t        vtimers;
241 	uint32_t loadTag; /* dext ID used for logging identity */
242 
243 	/* Globally uniqueid to identify tasks and corpses */
244 	uint64_t        task_uniqueid;
245 
246 	/* Miscellaneous */
247 	vm_map_t        XNU_PTRAUTH_SIGNED_PTR("task.map") map; /* Address space description */
248 	queue_chain_t   tasks;  /* global list of tasks */
249 	struct task_watchports *watchports; /* watchports passed in spawn */
250 	turnstile_inheritor_t returnwait_inheritor; /* inheritor for task_wait */
251 
252 	/* Threads in this task */
253 	queue_head_t            threads;
254 	struct restartable_ranges *t_rr_ranges;
255 
256 	processor_set_t         pset_hint;
257 	struct affinity_space   *affinity_space;
258 
259 	int                     thread_count;
260 	uint32_t                active_thread_count;
261 	int                     suspend_count;  /* Internal scheduling only */
262 #ifdef CONFIG_TASK_SUSPEND_STATS
263 	struct task_suspend_stats_s t_suspend_stats; /* suspension statistics for this task */
264 	task_suspend_source_array_t t_suspend_sources; /* array of suspender debug info for this task */
265 #endif /* CONFIG_TASK_SUSPEND_STATS */
266 
267 	/* User-visible scheduling information */
268 	integer_t               user_stop_count;        /* outstanding stops */
269 	integer_t               legacy_stop_count;      /* outstanding legacy stops */
270 
271 	int16_t                 priority;               /* base priority for threads */
272 	int16_t                 max_priority;           /* maximum priority for threads */
273 
274 	integer_t               importance;             /* priority offset (BSD 'nice' value) */
275 
276 	/* Statistics */
277 	uint64_t                total_runnable_time;
278 
279 	struct recount_task     tk_recount;
280 
281 	/* IPC structures */
282 	decl_lck_mtx_data(, itk_lock_data);
283 	/*
284 	 * Different flavors of task port.
285 	 * These flavors TASK_FLAVOR_* are defined in mach_types.h
286 	 */
287 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_task_ports") itk_task_ports[TASK_SELF_PORT_COUNT];
288 #if CONFIG_CSR
289 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_settable_self") itk_settable_self;   /* a send right */
290 #endif /* CONFIG_CSR */
291 	struct exception_action exc_actions[EXC_TYPES_COUNT];
292 	/* special exception port used by task_register_hardened_exception_handler */
293 	struct hardened_exception_action hardened_exception_action;
294 	/* a send right each valid element  */
295 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_host") itk_host;                     /* a send right */
296 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_bootstrap") itk_bootstrap;           /* a send right */
297 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_debug_control") itk_debug_control;   /* send right for debugmode communications */
298 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_task_access") itk_task_access;       /* and another send right */
299 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_resume") itk_resume;                 /* a receive right to resume this task */
300 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_registered") itk_registered[TASK_PORT_REGISTER_MAX];
301 	/* all send rights */
302 	ipc_port_t * XNU_PTRAUTH_SIGNED_PTR("task.itk_dyld_notify") itk_dyld_notify; /* lazy send rights array of size DYLD_MAX_PROCESS_INFO_NOTIFY_COUNT */
303 #if CONFIG_PROC_RESOURCE_LIMITS
304 	struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_resource_notify") itk_resource_notify; /* a send right to the resource notify port */
305 #endif /* CONFIG_PROC_RESOURCE_LIMITS */
306 	struct ipc_space * XNU_PTRAUTH_SIGNED_PTR("task.itk_space") itk_space;
307 
308 	ledger_t        ledger;
309 	/* Synchronizer ownership information */
310 	queue_head_t    semaphore_list;         /* list of owned semaphores   */
311 	int             semaphores_owned;       /* number of semaphores owned */
312 
313 	unsigned int    priv_flags;                     /* privilege resource flags */
314 #define VM_BACKING_STORE_PRIV   0x1
315 
316 	MACHINE_TASK
317 
318 	counter_t faults;             /* faults counter */
319 	counter_t pageins;            /* pageins counter */
320 	counter_t cow_faults;         /* copy on write fault counter */
321 	counter_t messages_sent;      /* messages sent counter */
322 	counter_t messages_received;  /* messages received counter */
323 	uint32_t decompressions;      /* decompression counter (from threads that already terminated) */
324 	uint32_t syscalls_mach;       /* mach system call counter */
325 	uint32_t syscalls_unix;       /* unix system call counter */
326 	uint32_t c_switch;            /* total context switches */
327 	uint32_t p_switch;            /* total processor switches */
328 	uint32_t ps_switch;           /* total pset switches */
329 
330 #ifdef  MACH_BSD
331 	struct proc_ro *                bsd_info_ro;
332 #endif
333 	kcdata_descriptor_t             corpse_info;
334 	uint64_t                        crashed_thread_id;
335 	queue_chain_t                   corpse_tasks;
336 #ifdef CONFIG_MACF
337 	struct label *                  crash_label;
338 #endif
339 	volatile uint32_t t_flags;                                      /* general-purpose task flags protected by task_lock (TL) */
340 #define TF_NONE                 0
341 #define TF_64B_ADDR             0x00000001                              /* task has 64-bit addressing */
342 #define TF_64B_DATA             0x00000002                              /* task has 64-bit data registers */
343 #define TF_CPUMON_WARNING       0x00000004                              /* task has at least one thread in CPU usage warning zone */
344 #define TF_WAKEMON_WARNING      0x00000008                              /* task is in wakeups monitor warning zone */
345 #define TF_TELEMETRY            (TF_CPUMON_WARNING | TF_WAKEMON_WARNING) /* task is a telemetry participant */
346 #define TF_GPU_DENIED           0x00000010                              /* task is not allowed to access the GPU */
347 #define TF_PENDING_CORPSE       0x00000040                              /* task corpse has not been reported yet */
348 #define TF_CORPSE_FORK          0x00000080                              /* task is a forked corpse */
349 #define TF_CA_CLIENT_WI         0x00000800                              /* task has CA_CLIENT work interval */
350 #define TF_DARKWAKE_MODE        0x00001000                              /* task is in darkwake mode */
351 #define TF_NO_SMT               0x00002000                              /* task threads must not be paired with SMT threads */
352 #define TF_SYS_VERSION_COMPAT   0x00008000                              /* shim task accesses to OS version data (macOS - app compatibility) */
353 #define TF_TECS                 0x00020000                              /* task threads must enable CPU security */
354 #if defined(__x86_64__)
355 #define TF_INSN_COPY_OPTOUT     0x00040000                              /* task threads opt out of unhandled-fault instruction stream collection */
356 #endif
357 #define TF_COALITION_MEMBER     0x00080000                              /* task is a member of a coalition */
358 #define TF_NO_CORPSE_FORKING    0x00100000                              /* do not fork a corpse for this task */
359 #define TF_USE_PSET_HINT_CLUSTER_TYPE 0x00200000                        /* bind task to task->pset_hint->pset_cluster_type */
360 #define TF_DYLD_ALL_IMAGE_FINAL   0x00400000                            /* all_image_info_addr can no longer be changed */
361 #define TF_HASPROC              0x00800000                              /* task points to a proc */
362 #define TF_GAME_MODE            0x40000000                              /* Set the game mode bit for CLPC */
363 #define TF_CARPLAY_MODE         0x80000000                              /* Set the carplay mode bit for CLPC */
364 
365 /*
366  * WARNING: These TF_ and TFRO_ flags are NOT automatically inherited by a child of fork
367  * If you believe something should be inherited, you must manually inherit the flags in `task_create_internal`
368  */
369 
370 /*
371  * RO-protected flags:
372  */
373 #define TFRO_CORPSE                     0x00000020                      /* task is a corpse */
374 #if XNU_TARGET_OS_OSX
375 #define TFRO_MACH_HARDENING_OPT_OUT     0x00000040                      /* task might load third party plugins on macOS and should be opted out of mach hardening */
376 #endif /* XNU_TARGET_OS_OSX */
377 #define TFRO_PLATFORM                   0x00000080                      /* task is a platform binary */
378 
379 #define TFRO_FILTER_MSG                 0x00004000                      /* task calls into message filter callback before sending a message */
380 #define TFRO_PAC_EXC_FATAL              0x00010000                      /* task is marked a corpse if a PAC exception occurs */
381 #define TFRO_JIT_EXC_FATAL              0x00020000                      /* kill the task on access violations from privileged JIT code */
382 #define TFRO_PAC_ENFORCE_USER_STATE     0x01000000                      /* Enforce user and kernel signed thread state */
383 #if CONFIG_EXCLAVES
384 #define TFRO_HAS_KD_ACCESS              0x02000000                      /* Access to the kernel exclave resource domain  */
385 #endif /* CONFIG_EXCLAVES */
386 #define TFRO_FREEZE_EXCEPTION_PORTS     0x04000000                      /* Setting new exception ports on the task/thread is disallowed */
387 #if CONFIG_EXCLAVES
388 #define TFRO_HAS_SENSOR_MIN_ON_TIME_ACCESS     0x08000000               /* Access to sensor minimum on time call  */
389 #endif /* CONFIG_EXCLAVES */
390 
391 /*
392  * Task is running within a 64-bit address space.
393  */
394 #define task_has_64Bit_addr(task)       \
395 	(((task)->t_flags & TF_64B_ADDR) != 0)
396 #define task_set_64Bit_addr(task)       \
397 	((task)->t_flags |= TF_64B_ADDR)
398 #define task_clear_64Bit_addr(task)     \
399 	((task)->t_flags &= ~TF_64B_ADDR)
400 
401 /*
402  * Task is using 64-bit machine state.
403  */
404 #define task_has_64Bit_data(task)       \
405 	(((task)->t_flags & TF_64B_DATA) != 0)
406 #define task_set_64Bit_data(task)       \
407 	((task)->t_flags |= TF_64B_DATA)
408 #define task_clear_64Bit_data(task)     \
409 	((task)->t_flags &= ~TF_64B_DATA)
410 
411 #define task_corpse_pending_report(task)        \
412 	 (((task)->t_flags & TF_PENDING_CORPSE) != 0)
413 
414 #define task_set_corpse_pending_report(task)       \
415 	 ((task)->t_flags |= TF_PENDING_CORPSE)
416 
417 #define task_clear_corpse_pending_report(task)       \
418 	 ((task)->t_flags &= ~TF_PENDING_CORPSE)
419 
420 #define task_is_a_corpse_fork(task)     \
421 	(((task)->t_flags & TF_CORPSE_FORK) != 0)
422 
423 #define task_set_coalition_member(task)      \
424 	((task)->t_flags |= TF_COALITION_MEMBER)
425 
426 #define task_clear_coalition_member(task)    \
427 	((task)->t_flags &= ~TF_COALITION_MEMBER)
428 
429 #define task_is_coalition_member(task)       \
430 	(((task)->t_flags & TF_COALITION_MEMBER) != 0)
431 
432 #define task_has_proc(task) \
433 	(((task)->t_flags & TF_HASPROC) != 0)
434 
435 #define task_set_has_proc(task) \
436 	((task)->t_flags |= TF_HASPROC)
437 
438 #define task_clear_has_proc(task) \
439 	((task)->t_flags &= ~TF_HASPROC)
440 
441 	uint32_t t_procflags;                                            /* general-purpose task flags protected by proc_lock (PL) */
442 #define TPF_NONE                 0
443 #define TPF_DID_EXEC             0x00000001                              /* task has been execed to a new task */
444 #define TPF_EXEC_COPY            0x00000002                              /* task is the new copy of an exec */
445 
446 #define task_did_exec_internal(task)            \
447 	(((task)->t_procflags & TPF_DID_EXEC) != 0)
448 
449 #define task_is_exec_copy_internal(task)        \
450 	(((task)->t_procflags & TPF_EXEC_COPY) != 0)
451 
452 	mach_vm_address_t       all_image_info_addr; /* dyld __all_image_info     */
453 	mach_vm_size_t          all_image_info_size; /* section location and size */
454 
455 #if CONFIG_CPU_COUNTERS
456 #define TASK_KPC_FORCED_ALL_CTRS        0x2     /* Bit in "t_kpc" signifying this task forced all counters */
457 	uint32_t t_kpc; /* kpc flags */
458 #endif /* CONFIG_CPU_COUNTERS */
459 
460 	_Atomic darwin_gpu_role_t       t_gpu_role;
461 
462 	bool pidsuspended; /* pid_suspend called; no threads can execute */
463 	bool frozen;       /* frozen; private resident pages committed to swap */
464 	bool changing_freeze_state;        /* in the process of freezing or thawing */
465 	bool     is_large_corpse;
466 	uint16_t policy_ru_cpu          :4,
467 	    policy_ru_cpu_ext      :4,
468 	    applied_ru_cpu         :4,
469 	    applied_ru_cpu_ext     :4;
470 	uint8_t  rusage_cpu_flags;
471 	uint8_t  rusage_cpu_percentage;         /* Task-wide CPU limit percentage */
472 	uint8_t  rusage_cpu_perthr_percentage;  /* Per-thread CPU limit percentage */
473 #if MACH_ASSERT
474 	int8_t          suspends_outstanding;   /* suspends this task performed in excess of resumes */
475 #endif
476 	uint8_t                  t_returnwaitflags;
477 #define TWF_NONE                 0
478 #define TRW_LRETURNWAIT          0x01           /* task is waiting for fork/posix_spawn/exec to complete */
479 #define TRW_LRETURNWAITER        0x02           /* task is waiting for TRW_LRETURNWAIT to get cleared */
480 #define TRW_LEXEC_COMPLETE       0x04           /* thread should call exec complete */
481 
482 #if CONFIG_EXCLAVES
483 	uint8_t                  t_exclave_state;
484 #define TES_NONE                 0
485 #define TES_CONCLAVE_TAINTED     0x01           /* Task has talked to conclave, xnu has tainted the process */
486 #define TES_CONCLAVE_UNTAINTABLE 0x02           /* Task can not be tainted by xnu when it talks to conclave */
487 #endif /* CONFIG_EXCLAVES */
488 
489 #if __has_feature(ptrauth_calls)
490 	bool                            shared_region_auth_remapped;    /* authenticated sections ready for use */
491 	char                            *shared_region_id;              /* determines which ptr auth key to use */
492 #endif /* __has_feature(ptrauth_calls) */
493 	struct vm_shared_region         *shared_region;
494 
495 	uint64_t rusage_cpu_interval;           /* Task-wide CPU limit interval */
496 	uint64_t rusage_cpu_perthr_interval;    /* Per-thread CPU limit interval */
497 	uint64_t rusage_cpu_deadline;
498 	thread_call_t rusage_cpu_callt;
499 #if CONFIG_TASKWATCH
500 	queue_head_t    task_watchers;          /* app state watcher threads */
501 	int     num_taskwatchers;
502 	int             watchapplying;
503 #endif /* CONFIG_TASKWATCH */
504 
505 	struct bank_task *bank_context;  /* pointer to per task bank structure */
506 
507 #if IMPORTANCE_INHERITANCE
508 	struct ipc_importance_task  *task_imp_base;     /* Base of IPC importance chain */
509 #endif /* IMPORTANCE_INHERITANCE */
510 
511 	vm_extmod_statistics_data_t     extmod_statistics;
512 
513 	struct task_requested_policy requested_policy;
514 	struct task_effective_policy effective_policy;
515 
516 	struct task_pend_token pended_coalition_changes;
517 
518 	/*
519 	 * Can be merged with imp_donor bits, once the IMPORTANCE_INHERITANCE macro goes away.
520 	 */
521 	uint32_t        low_mem_notified_warn           :1,     /* warning low memory notification is sent to the task */
522 	    low_mem_notified_critical       :1,                 /* critical low memory notification is sent to the task */
523 	    purged_memory_warn              :1,                 /* purgeable memory of the task is purged for warning level pressure */
524 	    purged_memory_critical          :1,                 /* purgeable memory of the task is purged for critical level pressure */
525 	    low_mem_privileged_listener     :1,                 /* if set, task would like to know about pressure changes before other tasks on the system */
526 	    mem_notify_reserved             :27;                /* reserved for future use */
527 
528 	task_memlimit_flags_t _Atomic memlimit_flags;
529 
530 	io_stat_info_t          task_io_stats;
531 
532 	struct task_writes_counters task_writes_counters_internal;
533 	struct task_writes_counters task_writes_counters_external;
534 
535 	/*
536 	 * The cpu_time_qos_stats fields are protected by the task lock
537 	 */
538 	struct _cpu_time_qos_stats      cpu_time_eqos_stats;
539 	struct _cpu_time_qos_stats      cpu_time_rqos_stats;
540 
541 	/* Statistics accumulated for terminated threads from this task */
542 	uint32_t        task_timer_wakeups_bin_1;
543 	uint32_t        task_timer_wakeups_bin_2;
544 	uint64_t        task_gpu_ns;
545 
546 	uint8_t         task_can_transfer_memory_ownership;
547 #if DEVELOPMENT || DEBUG
548 	uint8_t         task_no_footprint_for_debug;
549 #endif
550 	uint8_t         task_objects_disowning;
551 	uint8_t         task_objects_disowned;
552 	/* # of purgeable volatile VM objects owned by this task: */
553 	int             task_volatile_objects;
554 	/* # of purgeable but not volatile VM objects owned by this task: */
555 	int             task_nonvolatile_objects;
556 	int             task_owned_objects;
557 	queue_head_t    task_objq;
558 	decl_lck_mtx_data(, task_objq_lock); /* protects "task_objq" */
559 
560 	unsigned int    task_thread_limit:16;
561 #if __arm64__
562 	unsigned int    task_legacy_footprint:1;
563 	unsigned int    task_extra_footprint_limit:1;
564 	unsigned int    task_ios13extended_footprint_limit:1;
565 #endif /* __arm64__ */
566 	unsigned int    task_region_footprint:1;
567 	unsigned int    task_region_info_flags:1;
568 	unsigned int    task_has_crossed_thread_limit:1;
569 	unsigned int    task_rr_in_flight:1; /* a t_rr_synchronzie() is in flight */
570 	unsigned int    task_jetsam_realtime_audio:1;
571 
572 	/*
573 	 * A task's coalition set is "adopted" in task_create_internal
574 	 * and unset in task_deallocate_internal, so each array member
575 	 * can be referenced without the task lock.
576 	 * Note: these fields are protected by coalition->lock,
577 	 *       not the task lock.
578 	 */
579 	coalition_t     coalition[COALITION_NUM_TYPES];
580 	queue_chain_t   task_coalition[COALITION_NUM_TYPES];
581 	uint64_t        dispatchqueue_offset;
582 
583 #if DEVELOPMENT || DEBUG
584 	boolean_t       task_unnested;
585 	int             task_disconnected_count;
586 #endif
587 
588 #if HYPERVISOR
589 	void * XNU_PTRAUTH_SIGNED_PTR("task.hv_task_target") hv_task_target; /* hypervisor virtual machine object associated with this task */
590 #endif /* HYPERVISOR */
591 
592 #if CONFIG_SECLUDED_MEMORY
593 	uint8_t task_can_use_secluded_mem;
594 	uint8_t task_could_use_secluded_mem;
595 	uint8_t task_could_also_use_secluded_mem;
596 	uint8_t task_suppressed_secluded;
597 #endif /* CONFIG_SECLUDED_MEMORY */
598 
599 	task_exc_guard_behavior_t task_exc_guard;
600 	mach_vm_address_t mach_header_vm_address;
601 
602 	queue_head_t    io_user_clients;
603 
604 #if CONFIG_FREEZE
605 	queue_head_t   task_frozen_cseg_q;  /* queue of csegs frozen to NAND */
606 #endif /* CONFIG_FREEZE */
607 	boolean_t       donates_own_pages; /* pages land on the special Q (only swappable pages on iPadOS, early swap on macOS) */
608 	uint32_t task_shared_region_slide;   /* cached here to avoid locking during telemetry */
609 #if CONFIG_PHYS_WRITE_ACCT
610 	uint64_t        task_fs_metadata_writes;
611 #endif /* CONFIG_PHYS_WRITE_ACCT */
612 	uuid_t   task_shared_region_uuid;
613 #if CONFIG_MEMORYSTATUS
614 	uint64_t        memstat_dirty_start; /* last abstime transition into the dirty band or last call to task_ledger_settle_dirty_time  while dirty */
615 #endif /* CONFIG_MEMORYSTATUS */
616 	vmobject_list_output_t corpse_vmobject_list;
617 	uint64_t corpse_vmobject_list_size;
618 #if CONFIG_DEFERRED_RECLAIM
619 	vm_deferred_reclamation_metadata_t deferred_reclamation_metadata; /* Protected by the task lock */
620 #endif /* CONFIG_DEFERRED_RECLAIM */
621 
622 #if CONFIG_EXCLAVES
623 	void * XNU_PTRAUTH_SIGNED_PTR("task.conclave") conclave;
624 	void * XNU_PTRAUTH_SIGNED_PTR("task.exclave_crash_info") exclave_crash_info;
625 	uint32_t exclave_crash_info_length;
626 #endif /* CONFIG_EXCLAVES */
627 
628 	/* Auxiliary code-signing information */
629 	uint64_t task_cs_auxiliary_info;
630 
631 	/* Runtime security mitigations */
632 	task_security_config_s security_config;
633 };
634 
635 ZONE_DECLARE_ID(ZONE_ID_PROC_TASK, void *);
636 extern zone_t proc_task_zone;
637 
638 extern task_control_port_options_t task_get_control_port_options(task_t task);
639 
640 /*
641  * EXC_GUARD default delivery behavior for optional Mach port and VM guards.
642  * Applied to new tasks at creation time.
643  */
644 extern task_exc_guard_behavior_t task_exc_guard_default;
645 extern size_t proc_and_task_size;
646 extern void  *get_bsdtask_info(task_t t);
647 extern void *task_get_proc_raw(task_t task);
648 static inline void
task_require(struct task * task)649 task_require(struct task *task)
650 {
651 	zone_id_require(ZONE_ID_PROC_TASK, proc_and_task_size, task_get_proc_raw(task));
652 }
653 
654 #define task_lock(task)                 lck_mtx_lock(&(task)->lock)
655 #define task_lock_assert_owned(task)    LCK_MTX_ASSERT(&(task)->lock, LCK_MTX_ASSERT_OWNED)
656 #define task_lock_try(task)             lck_mtx_try_lock(&(task)->lock)
657 #define task_unlock(task)               lck_mtx_unlock(&(task)->lock)
658 
659 #define task_objq_lock_init(task)       lck_mtx_init(&(task)->task_objq_lock, &vm_object_lck_grp, &vm_object_lck_attr)
660 #define task_objq_lock_destroy(task)    lck_mtx_destroy(&(task)->task_objq_lock, &vm_object_lck_grp)
661 #define task_objq_lock(task)            lck_mtx_lock(&(task)->task_objq_lock)
662 #define task_objq_lock_assert_owned(task)       LCK_MTX_ASSERT(&(task)->task_objq_lock, LCK_MTX_ASSERT_OWNED)
663 #define task_objq_lock_try(task)        lck_mtx_try_lock(&(task)->task_objq_lock)
664 #define task_objq_unlock(task)          lck_mtx_unlock(&(task)->task_objq_lock)
665 
666 #define itk_lock_init(task)     lck_mtx_init(&(task)->itk_lock_data, &ipc_lck_grp, &ipc_lck_attr)
667 #define itk_lock_destroy(task)  lck_mtx_destroy(&(task)->itk_lock_data, &ipc_lck_grp)
668 #define itk_lock(task)          lck_mtx_lock(&(task)->itk_lock_data)
669 #define itk_unlock(task)        lck_mtx_unlock(&(task)->itk_lock_data)
670 
671 /* task clear return wait flags */
672 #define TCRW_CLEAR_INITIAL_WAIT   0x1
673 #define TCRW_CLEAR_FINAL_WAIT     0x2
674 #define TCRW_CLEAR_EXEC_COMPLETE  0x4
675 #define TCRW_CLEAR_ALL_WAIT       (TCRW_CLEAR_INITIAL_WAIT | TCRW_CLEAR_FINAL_WAIT)
676 
677 /* Initialize task module */
678 extern void             task_init(void);
679 
680 /* coalition_init() calls this to initialize ledgers before task_init() */
681 extern void             init_task_ledgers(void);
682 
683 extern task_t   current_task(void) __pure2;
684 
685 __pure2
686 static inline ipc_space_t
current_space(void)687 current_space(void)
688 {
689 	return current_task()->itk_space;
690 }
691 
692 extern bool task_is_driver(task_t task);
693 extern uint32_t task_ro_flags_get(task_t task);
694 extern void task_ro_flags_set(task_t task, uint32_t flags);
695 extern void task_ro_flags_clear(task_t task, uint32_t flags);
696 
697 extern lck_attr_t      task_lck_attr;
698 extern lck_grp_t       task_lck_grp;
699 
700 struct task_watchport_elem {
701 	task_t                          twe_task;
702 	ipc_port_t                      twe_port;     /* (Space lock) */
703 	ipc_port_t XNU_PTRAUTH_SIGNED_PTR("twe_pdrequest") twe_pdrequest;
704 };
705 
706 struct task_watchports {
707 	os_refcnt_t                     tw_refcount;           /* (Space lock) */
708 	task_t                          tw_task;               /* (Space lock) & tw_refcount == 0 */
709 	thread_t                        tw_thread;             /* (Space lock) & tw_refcount == 0 */
710 	uint32_t                        tw_elem_array_count;   /* (Space lock) */
711 	struct task_watchport_elem      tw_elem[];             /* (Space lock) & (Portlock) & (mq lock) */
712 };
713 
714 #define task_watchports_retain(x)   (os_ref_retain(&(x)->tw_refcount))
715 #define task_watchports_release(x)  (os_ref_release(&(x)->tw_refcount))
716 
717 #define task_watchport_elem_init(elem, task, port) \
718 do {                                               \
719 	(elem)->twe_task = (task);                 \
720 	(elem)->twe_port = (port);                 \
721 	(elem)->twe_pdrequest = IP_NULL;           \
722 } while(0)
723 
724 #define task_watchport_elem_clear(elem) task_watchport_elem_init((elem), NULL, NULL)
725 
726 extern void
727 task_add_turnstile_watchports(
728 	task_t          task,
729 	thread_t        thread,
730 	ipc_port_t      *portwatch_ports,
731 	uint32_t        portwatch_count);
732 
733 extern void
734 task_watchport_elem_deallocate(
735 	struct          task_watchport_elem *watchport_elem);
736 
737 extern boolean_t
738 task_has_watchports(task_t task);
739 
740 void
741 task_dyld_process_info_update_helper(
742 	task_t                  task,
743 	size_t                  active_count,
744 	vm_map_address_t        magic_addr,
745 	ipc_port_t             *release_ports,
746 	size_t                  release_count);
747 
748 extern kern_return_t
749 task_suspend2_mig(
750 	task_t                  task,
751 	task_suspension_token_t *suspend_token);
752 
753 extern kern_return_t
754 task_suspend2_external(
755 	task_t                  task,
756 	task_suspension_token_t *suspend_token);
757 
758 extern kern_return_t
759 task_resume2_mig(
760 	task_suspension_token_t suspend_token);
761 
762 extern kern_return_t
763 task_resume2_external(
764 	task_suspension_token_t suspend_token);
765 
766 extern void
767 task_suspension_token_deallocate_grp(
768 	task_suspension_token_t suspend_token,
769 	task_grp_t              grp);
770 
771 extern ipc_port_t
772 convert_task_to_port_with_flavor(
773 	task_t                  task,
774 	mach_task_flavor_t      flavor,
775 	task_grp_t              grp);
776 
777 extern task_t   current_task_early(void) __pure2;
778 
779 #else   /* MACH_KERNEL_PRIVATE */
780 
781 __BEGIN_DECLS
782 
783 extern task_t   current_task(void) __pure2;
784 
785 extern bool task_is_driver(task_t task);
786 
787 #define TF_NONE                 0
788 
789 #define TWF_NONE                 0
790 #define TRW_LRETURNWAIT          0x01           /* task is waiting for fork/posix_spawn/exec to complete */
791 #define TRW_LRETURNWAITER        0x02           /* task is waiting for TRW_LRETURNWAIT to get cleared */
792 #define TRW_LEXEC_COMPLETE       0x04           /* thread should call exec complete */
793 
794 /* task clear return wait flags */
795 #define TCRW_CLEAR_INITIAL_WAIT   0x1
796 #define TCRW_CLEAR_FINAL_WAIT     0x2
797 #define TCRW_CLEAR_EXEC_COMPLETE  0x4
798 #define TCRW_CLEAR_ALL_WAIT       (TCRW_CLEAR_INITIAL_WAIT | TCRW_CLEAR_FINAL_WAIT)
799 
800 
801 #define TPF_NONE                0
802 #define TPF_EXEC_COPY           0x00000002                              /* task is the new copy of an exec */
803 
804 
805 __END_DECLS
806 
807 #endif  /* MACH_KERNEL_PRIVATE */
808 
809 __BEGIN_DECLS
810 
811 #ifdef KERNEL_PRIVATE
812 extern boolean_t                task_is_app_suspended(task_t task);
813 extern bool task_is_exotic(task_t task);
814 extern bool task_is_alien(task_t task);
815 extern boolean_t task_get_platform_binary(task_t task);
816 #endif /* KERNEL_PRIVATE */
817 
818 #ifdef  XNU_KERNEL_PRIVATE
819 
820 /* Hold all threads in a task, Wait for task to stop running, just to get off CPU */
821 extern kern_return_t task_hold_and_wait(
822 	task_t          task,
823 	bool            suspend_conclave);
824 
825 /* Release hold on all threads in a task */
826 extern kern_return_t    task_release(
827 	task_t          task);
828 
829 /* Suspend/resume a task where the kernel owns the suspend count */
830 extern kern_return_t    task_suspend_internal(          task_t          task);
831 extern kern_return_t    task_resume_internal(           task_t          task);
832 
833 /* Suspends a task by placing a hold on its threads */
834 extern kern_return_t    task_pidsuspend(
835 	task_t          task);
836 
837 /* Resumes a previously paused task */
838 extern kern_return_t    task_pidresume(
839 	task_t          task);
840 
841 extern kern_return_t    task_send_trace_memory(
842 	task_t          task,
843 	uint32_t        pid,
844 	uint64_t        uniqueid);
845 
846 extern void             task_remove_turnstile_watchports(
847 	task_t          task);
848 
849 extern void             task_transfer_turnstile_watchports(
850 	task_t          old_task,
851 	task_t          new_task,
852 	thread_t        new_thread);
853 
854 extern kern_return_t
855     task_violated_guard(mach_exception_code_t, mach_exception_subcode_t, void *, bool);
856 
857 #if DEVELOPMENT || DEBUG
858 
859 extern kern_return_t    task_disconnect_page_mappings(
860 	task_t          task);
861 #endif /* DEVELOPMENT || DEBUG */
862 
863 extern void                     tasks_system_suspend(boolean_t suspend);
864 
865 #if CONFIG_FREEZE
866 
867 /* Freeze a task's resident pages */
868 extern kern_return_t    task_freeze(
869 	task_t          task,
870 	uint32_t        *purgeable_count,
871 	uint32_t        *wired_count,
872 	uint32_t        *clean_count,
873 	uint32_t        *dirty_count,
874 	uint32_t        dirty_budget,
875 	uint32_t        *shared_count,
876 	int             *freezer_error_code,
877 	boolean_t       eval_only);
878 
879 /* Thaw a currently frozen task */
880 extern kern_return_t    task_thaw(
881 	task_t          task);
882 
883 typedef enum {
884 	CREDIT_TO_SWAP = 1,
885 	DEBIT_FROM_SWAP = 2
886 } freezer_acct_op_t;
887 
888 extern void task_update_frozen_to_swap_acct(
889 	task_t  task,
890 	int64_t amount,
891 	freezer_acct_op_t op);
892 
893 #endif /* CONFIG_FREEZE */
894 
895 /* Halt all other threads in the current task */
896 extern kern_return_t    task_start_halt(
897 	task_t          task);
898 
899 /* Wait for other threads to halt and free halting task resources */
900 extern void             task_complete_halt(
901 	task_t          task);
902 
903 extern kern_return_t    task_terminate_internal(
904 	task_t                  task);
905 
906 struct proc_ro;
907 typedef struct proc_ro *proc_ro_t;
908 
909 extern kern_return_t    task_create_internal(
910 	task_t          parent_task,
911 	proc_ro_t       proc_ro,
912 	coalition_t     *parent_coalitions,
913 	boolean_t       inherit_memory,
914 	boolean_t       is_64bit,
915 	boolean_t       is_64bit_data,
916 	uint32_t        t_flags,
917 	uint32_t        t_flags_ro,
918 	uint32_t        procflags,
919 	uint8_t         t_returnwaitflags,
920 	task_t          child_task);
921 
922 extern kern_return_t    task_set_special_port_internal(
923 	task_t                  task,
924 	int                     which,
925 	ipc_port_t              port);
926 
927 extern kern_return_t task_set_security_tokens(
928 	task_t                  task,
929 	security_token_t        sec_token,
930 	audit_token_t           audit_token,
931 	host_priv_t             host_priv);
932 
933 extern kern_return_t    task_info(
934 	task_t                  task,
935 	task_flavor_t           flavor,
936 	task_info_t             task_info_out,
937 	mach_msg_type_number_t  *task_info_count);
938 
939 /*
940  * Additional fields that aren't exposed through `task_power_info` but needed
941  * by clients of `task_power_info_locked`.
942  */
943 struct task_power_info_extra {
944 	uint64_t cycles;
945 	uint64_t instructions;
946 	uint64_t pcycles;
947 	uint64_t pinstructions;
948 	uint64_t user_ptime;
949 	uint64_t system_ptime;
950 	uint64_t runnable_time;
951 	uint64_t energy;
952 	uint64_t penergy;
953 	uint64_t secure_time;
954 	uint64_t secure_ptime;
955 };
956 
957 void task_power_info_locked(
958 	task_t                        task,
959 	task_power_info_t             info,
960 	gpu_energy_data_t             gpu_energy,
961 	task_power_info_v2_t          infov2,
962 	struct task_power_info_extra *extra_info);
963 
964 extern uint64_t         task_gpu_utilisation(
965 	task_t   task);
966 
967 extern void             task_update_cpu_time_qos_stats(
968 	task_t   task,
969 	uint64_t *eqos_stats,
970 	uint64_t *rqos_stats);
971 
972 extern void             task_vtimer_set(
973 	task_t          task,
974 	integer_t       which);
975 
976 extern void             task_vtimer_clear(
977 	task_t          task,
978 	integer_t       which);
979 
980 extern void             task_vtimer_update(
981 	task_t          task,
982 	integer_t       which,
983 	uint32_t        *microsecs);
984 
985 #define TASK_VTIMER_USER                0x01
986 #define TASK_VTIMER_PROF                0x02
987 #define TASK_VTIMER_RLIM                0x04
988 
989 extern void             task_set_64bit(
990 	task_t          task,
991 	boolean_t       is_64bit,
992 	boolean_t       is_64bit_data);
993 
994 extern bool             task_get_64bit_addr(
995 	task_t task);
996 
997 extern bool             task_get_64bit_data(
998 	task_t task);
999 
1000 extern void     task_set_platform_binary(
1001 	task_t task,
1002 	boolean_t is_platform);
1003 
1004 #if XNU_TARGET_OS_OSX
1005 #if DEVELOPMENT || DEBUG
1006 /* Disables task identity security hardening (*_set_exception_ports policy)
1007  * for all tasks if amfi_get_out_of_my_way is set. */
1008 extern bool AMFI_bootarg_disable_mach_hardening;
1009 #endif /* DEVELOPMENT || DEBUG */
1010 extern void             task_disable_mach_hardening(
1011 	task_t task);
1012 
1013 extern bool     task_opted_out_mach_hardening(
1014 	task_t task);
1015 #endif /* XNU_TARGET_OS_OSX */
1016 
1017 extern boolean_t task_is_a_corpse(
1018 	task_t task);
1019 
1020 extern boolean_t task_is_ipc_active(
1021 	task_t task);
1022 
1023 extern bool
1024 task_is_immovable_no_assert(task_t task);
1025 
1026 extern bool task_is_immovable(
1027 	task_t task);
1028 
1029 extern void task_set_corpse(
1030 	task_t task);
1031 
1032 extern void     task_set_exc_guard_default(
1033 	task_t task,
1034 	const char *name,
1035 	unsigned long namelen,
1036 	boolean_t is_simulated,
1037 	uint32_t platform,
1038 	uint32_t sdk);
1039 
1040 extern bool     task_set_ca_client_wi(
1041 	task_t task,
1042 	boolean_t ca_client_wi);
1043 
1044 extern kern_return_t task_set_dyld_info(
1045 	task_t            task,
1046 	mach_vm_address_t addr,
1047 	mach_vm_size_t    size,
1048 	bool              finalize_value);
1049 
1050 extern void task_set_mach_header_address(
1051 	task_t task,
1052 	mach_vm_address_t addr);
1053 
1054 extern void task_set_uniqueid(task_t task);
1055 
1056 /* Get number of activations in a task */
1057 extern int              get_task_numacts(
1058 	task_t          task);
1059 
1060 extern bool task_donates_own_pages(
1061 	task_t task);
1062 
1063 struct label;
1064 extern kern_return_t task_collect_crash_info(
1065 	task_t task,
1066 #if CONFIG_MACF
1067 	struct label *crash_label,
1068 #endif
1069 	int is_corpse_fork);
1070 void task_wait_till_threads_terminate_locked(task_t task);
1071 
1072 /* JMM - should just be temporary (implementation in bsd_kern still) */
1073 extern void     set_bsdtask_info(task_t, void *);
1074 extern uint32_t set_task_loadTag(task_t task, uint32_t loadTag);
1075 extern vm_map_t get_task_map_reference(task_t);
1076 extern vm_map_t swap_task_map(task_t, thread_t, vm_map_t);
1077 extern pmap_t   get_task_pmap(task_t);
1078 extern uint64_t get_task_resident_size(task_t);
1079 extern uint64_t get_task_compressed(task_t);
1080 extern uint64_t get_task_resident_max(task_t);
1081 extern uint64_t get_task_phys_footprint(task_t);
1082 #if CONFIG_LEDGER_INTERVAL_MAX
1083 extern uint64_t get_task_phys_footprint_interval_max(task_t, int reset);
1084 #endif /* CONFIG_FOOTPRINT_INTERVAL_MAX */
1085 extern uint64_t get_task_phys_footprint_lifetime_max(task_t);
1086 extern uint64_t get_task_phys_footprint_limit(task_t);
1087 extern uint64_t get_task_neural_nofootprint_total(task_t task);
1088 #if CONFIG_LEDGER_INTERVAL_MAX
1089 extern uint64_t get_task_neural_nofootprint_total_interval_max(task_t, int reset);
1090 #endif /* CONFIG_NEURAL_INTERVAL_MAX */
1091 extern uint64_t get_task_neural_nofootprint_total_lifetime_max(task_t);
1092 extern uint64_t get_task_purgeable_size(task_t);
1093 extern uint64_t get_task_cpu_time(task_t);
1094 extern uint64_t get_task_dispatchqueue_offset(task_t);
1095 extern uint64_t get_task_dispatchqueue_serialno_offset(task_t);
1096 extern uint64_t get_task_dispatchqueue_label_offset(task_t);
1097 extern uint64_t get_task_uniqueid(task_t task);
1098 extern int      get_task_version(task_t task);
1099 
1100 extern uint64_t get_task_internal(task_t);
1101 extern uint64_t get_task_internal_compressed(task_t);
1102 extern uint64_t get_task_purgeable_nonvolatile(task_t);
1103 extern uint64_t get_task_purgeable_nonvolatile_compressed(task_t);
1104 extern uint64_t get_task_iokit_mapped(task_t);
1105 extern uint64_t get_task_alternate_accounting(task_t);
1106 extern uint64_t get_task_alternate_accounting_compressed(task_t);
1107 extern uint64_t get_task_memory_region_count(task_t);
1108 extern uint64_t get_task_page_table(task_t);
1109 #if CONFIG_FREEZE
1110 extern uint64_t get_task_frozen_to_swap(task_t);
1111 #endif
1112 extern uint64_t get_task_network_nonvolatile(task_t);
1113 extern uint64_t get_task_network_nonvolatile_compressed(task_t);
1114 extern uint64_t get_task_wired_mem(task_t);
1115 extern uint32_t get_task_loadTag(task_t task);
1116 
1117 extern uint64_t get_task_tagged_footprint(task_t task);
1118 extern uint64_t get_task_tagged_footprint_compressed(task_t task);
1119 extern uint64_t get_task_media_footprint(task_t task);
1120 extern uint64_t get_task_media_footprint_compressed(task_t task);
1121 extern uint64_t get_task_graphics_footprint(task_t task);
1122 extern uint64_t get_task_graphics_footprint_compressed(task_t task);
1123 extern uint64_t get_task_neural_footprint(task_t task);
1124 extern uint64_t get_task_neural_footprint_compressed(task_t task);
1125 
1126 extern kern_return_t task_convert_phys_footprint_limit(int, int *);
1127 extern kern_return_t task_set_phys_footprint_limit_internal(task_t, int, int *, boolean_t, boolean_t);
1128 extern kern_return_t task_get_phys_footprint_limit(task_t task, int *limit_mb);
1129 #if DEBUG || DEVELOPMENT
1130 #if CONFIG_MEMORYSTATUS
1131 extern kern_return_t task_set_diag_footprint_limit_internal(task_t, uint64_t, uint64_t *);
1132 extern kern_return_t task_get_diag_footprint_limit_internal(task_t, uint64_t *, bool *);
1133 extern kern_return_t task_set_diag_footprint_limit(task_t task, uint64_t new_limit_mb, uint64_t *old_limit_mb);
1134 #endif /* CONFIG_MEMORYSTATUS */
1135 #endif /* DEBUG || DEVELOPMENT */
1136 extern kern_return_t task_get_conclave_mem_limit(task_t, uint64_t *conclave_limit);
1137 extern kern_return_t task_set_conclave_mem_limit(task_t, uint64_t conclave_limit);
1138 
1139 extern security_token_t *task_get_sec_token(task_t task);
1140 extern void task_set_sec_token(task_t task, security_token_t *token);
1141 extern audit_token_t *task_get_audit_token(task_t task);
1142 extern void task_set_audit_token(task_t task, audit_token_t *token);
1143 extern void task_set_tokens(task_t task, security_token_t *sec_token, audit_token_t *audit_token);
1144 extern boolean_t task_is_privileged(task_t task);
1145 extern uint8_t *task_get_mach_trap_filter_mask(task_t task);
1146 extern void task_set_mach_trap_filter_mask(task_t task, uint8_t *mask);
1147 extern uint8_t *task_get_mach_kobj_filter_mask(task_t task);
1148 extern void task_set_mach_kobj_filter_mask(task_t task, uint8_t *mask);
1149 extern mach_vm_address_t task_get_all_image_info_addr(task_t task);
1150 
1151 /* Jetsam memlimit attributes */
1152 extern bool task_get_memlimit_is_active(task_t task);
1153 extern bool task_get_memlimit_is_fatal(task_t task);
1154 extern void task_set_memlimit_is_active(task_t task, bool memlimit_is_active);
1155 extern void task_set_memlimit_is_fatal(task_t task, bool memlimit_is_fatal);
1156 extern bool task_set_exc_resource_bit(task_t task, bool memlimit_is_active);
1157 extern void task_reset_triggered_exc_resource(task_t task, bool memlimit_is_active);
1158 extern bool task_get_jetsam_realtime_audio(task_t task);
1159 extern void task_set_jetsam_realtime_audio(task_t task, bool realtime_audio);
1160 
1161 extern uint64_t task_get_dirty_start(task_t task);
1162 extern void task_set_dirty_start(task_t task, uint64_t start);
1163 
1164 extern void task_set_thread_limit(task_t task, uint16_t thread_limit);
1165 #if CONFIG_PROC_RESOURCE_LIMITS
1166 extern kern_return_t task_set_port_space_limits(task_t task, uint32_t soft_limit, uint32_t hard_limit);
1167 #endif /* CONFIG_PROC_RESOURCE_LIMITS */
1168 extern void task_port_space_ast(task_t task);
1169 
1170 #if XNU_TARGET_OS_OSX
1171 extern boolean_t task_has_system_version_compat_enabled(task_t task);
1172 extern void task_set_system_version_compat_enabled(task_t task, boolean_t enable_system_version_compat);
1173 #endif
1174 
1175 extern boolean_t        is_kerneltask(task_t task);
1176 extern boolean_t        is_corpsefork(task_t task);
1177 
1178 extern kern_return_t check_actforsig(task_t task, thread_t thread, int setast);
1179 
1180 extern kern_return_t machine_task_get_state(
1181 	task_t task,
1182 	int flavor,
1183 	thread_state_t state,
1184 	mach_msg_type_number_t *state_count);
1185 
1186 extern kern_return_t machine_task_set_state(
1187 	task_t task,
1188 	int flavor,
1189 	thread_state_t state,
1190 	mach_msg_type_number_t state_count);
1191 
1192 extern void machine_task_terminate(task_t task);
1193 
1194 extern kern_return_t machine_task_process_signature(task_t task, uint32_t platform, uint32_t sdk, char const **error_msg);
1195 
1196 struct _task_ledger_indices {
1197 	int cpu_time;
1198 	int tkm_private;
1199 	int tkm_shared;
1200 	int phys_mem;
1201 	int wired_mem;
1202 	int conclave_mem;
1203 	int internal;
1204 	int iokit_mapped;
1205 	int external;
1206 	int reusable;
1207 	int alternate_accounting;
1208 	int alternate_accounting_compressed;
1209 	int page_table;
1210 	int phys_footprint;
1211 	int internal_compressed;
1212 	int purgeable_volatile;
1213 	int purgeable_nonvolatile;
1214 	int purgeable_volatile_compressed;
1215 	int purgeable_nonvolatile_compressed;
1216 	int tagged_nofootprint;
1217 	int tagged_footprint;
1218 	int tagged_nofootprint_compressed;
1219 	int tagged_footprint_compressed;
1220 	int network_volatile;
1221 	int network_nonvolatile;
1222 	int network_volatile_compressed;
1223 	int network_nonvolatile_compressed;
1224 	int media_nofootprint;
1225 	int media_footprint;
1226 	int media_nofootprint_compressed;
1227 	int media_footprint_compressed;
1228 	int graphics_nofootprint;
1229 	int graphics_footprint;
1230 	int graphics_nofootprint_compressed;
1231 	int graphics_footprint_compressed;
1232 	int neural_nofootprint;
1233 	int neural_footprint;
1234 	int neural_nofootprint_compressed;
1235 	int neural_footprint_compressed;
1236 	int neural_nofootprint_total;
1237 	int platform_idle_wakeups;
1238 	int interrupt_wakeups;
1239 #if CONFIG_SCHED_SFI
1240 	int sfi_wait_times[MAX_SFI_CLASS_ID];
1241 #endif /* CONFIG_SCHED_SFI */
1242 	int cpu_time_billed_to_me;
1243 	int cpu_time_billed_to_others;
1244 	int physical_writes;
1245 	int logical_writes;
1246 	int logical_writes_to_external;
1247 	int energy_billed_to_me;
1248 	int energy_billed_to_others;
1249 #if CONFIG_MEMORYSTATUS
1250 	int memorystatus_dirty_time;
1251 #endif /* CONFIG_MEMORYSTATUS */
1252 	int pages_grabbed;
1253 	int pages_grabbed_kern;
1254 	int pages_grabbed_iopl;
1255 	int pages_grabbed_upl;
1256 #if CONFIG_DEFERRED_RECLAIM
1257 	int est_reclaimable;
1258 #endif /* CONFIG_DEFERRED_RECLAIM */
1259 #if CONFIG_FREEZE
1260 	int frozen_to_swap;
1261 #endif /* CONFIG_FREEZE */
1262 #if CONFIG_PHYS_WRITE_ACCT
1263 	int fs_metadata_writes;
1264 #endif /* CONFIG_PHYS_WRITE_ACCT */
1265 	int swapins;
1266 };
1267 
1268 /*
1269  * Each runtime security mitigation that we support for userland processes
1270  * is tracked in the task security configuration and managed by the following
1271  * helpers.
1272  */
1273 #define TASK_SECURITY_CONFIG_HELPER_DECLARE(suffix) \
1274 	extern bool task_has_##suffix(task_t); \
1275 	extern void task_set_##suffix(task_t); \
1276 	extern void task_clear_##suffix(task_t); \
1277     extern void task_no_set_##suffix(task_t task) \
1278 
1279 extern uint32_t task_get_security_config(task_t);
1280 
1281 TASK_SECURITY_CONFIG_HELPER_DECLARE(hardened_heap);
1282 TASK_SECURITY_CONFIG_HELPER_DECLARE(tpro);
1283 
1284 uint8_t task_get_platform_restrictions_version(task_t task);
1285 void    task_set_platform_restrictions_version(task_t task, uint64_t version);
1286 uint8_t task_get_hardened_process_version(task_t task);
1287 void    task_set_hardened_process_version(task_t task, uint64_t version);
1288 
1289 #if HAS_MTE || HAS_MTE_EMULATION_SHIMS
1290 TASK_SECURITY_CONFIG_HELPER_DECLARE(sec);
1291 /*
1292  * Definitions need to be visible on bsd/
1293  */
1294 
1295 #define TASK_MTE_POLICY_HELPER_DECLARE(suffix)  \
1296     extern bool task_has_sec_##suffix(task_t); \
1297 	extern void task_set_sec_##suffix(task_t)
1298 
1299 TASK_MTE_POLICY_HELPER_DECLARE(soft_mode);
1300 TASK_MTE_POLICY_HELPER_DECLARE(user_data);
1301 TASK_MTE_POLICY_HELPER_DECLARE(inherit);
1302 TASK_MTE_POLICY_HELPER_DECLARE(never_check);
1303 TASK_MTE_POLICY_HELPER_DECLARE(restrict_receiving_aliases_to_tagged_memory);
1304 
1305 extern bool current_task_has_sec_enabled(void);
1306 extern void task_clear_sec_policy(task_t);
1307 extern uint32_t task_get_sec_policy(task_t);
1308 #endif /* HAS_MTE || HAS_MTE_EMULATION_SHIMS */
1309 
1310 /*
1311  * Many of the task ledger entries use a reduced feature set
1312  * (specifically they just use LEDGER_ENTRY_ALLOW_PANIC_ON_NEGATIVE)
1313  * and are stored in a smaller entry structure.
1314  * That structure is an implementation detail of the ledger.
1315  * But on PPL systems, the task ledger's memory is managed by the PPL
1316  * and it has to determine the size of the task ledger at compile time.
1317  * This define specifies the number of small entries so the PPL can
1318  * properly determine the ledger's size.
1319  *
1320  * If you add a new entry with only the
1321  * LEDGER_ENTRY_ALLOW_PANIC_ON_NEGATIVE | LEDGER_ENTRY_ALLOW_INACTIVE
1322  * flags, you need to increment this count.
1323  * Otherwise, PPL systems will panic at boot.
1324  */
1325 #if CONFIG_DEFERRED_RECLAIM
1326 #define TASK_LEDGER_NUM_SMALL_INDICES 34
1327 #else /* CONFIG_DEFERRED_RECLAIM */
1328 #define TASK_LEDGER_NUM_SMALL_INDICES 33
1329 #endif /* !CONFIG_DEFERRED_RECLAIM */
1330 extern struct _task_ledger_indices task_ledgers;
1331 
1332 /* requires task to be unlocked, returns a referenced thread */
1333 thread_t task_findtid(task_t task, uint64_t tid);
1334 int pid_from_task(task_t task);
1335 
1336 extern kern_return_t task_wakeups_monitor_ctl(task_t task, uint32_t *rate_hz, int32_t *flags);
1337 extern kern_return_t task_cpu_usage_monitor_ctl(task_t task, uint32_t *flags);
1338 extern void task_rollup_accounting_info(task_t new_task, task_t parent_task);
1339 extern kern_return_t task_io_monitor_ctl(task_t task, uint32_t *flags);
1340 extern void task_set_did_exec_flag(task_t task);
1341 extern void task_clear_exec_copy_flag(task_t task);
1342 extern bool task_is_initproc(task_t task);
1343 extern boolean_t task_is_exec_copy(task_t);
1344 extern boolean_t task_did_exec(task_t task);
1345 extern boolean_t task_is_active(task_t task);
1346 extern boolean_t task_is_halting(task_t task);
1347 extern void task_clear_return_wait(task_t task, uint32_t flags);
1348 extern void task_set_ctrl_port_default(task_t task, thread_t thread);
1349 extern void task_wait_to_return(void) __attribute__((noreturn));
1350 extern void task_post_signature_processing_hook(task_t task);
1351 extern event_t task_get_return_wait_event(task_t task);
1352 
1353 extern void task_bank_reset(task_t task);
1354 extern void task_bank_init(task_t task);
1355 
1356 #if CONFIG_MEMORYSTATUS
1357 extern void task_ledger_settle_dirty_time(task_t t);
1358 extern void task_ledger_settle_dirty_time_locked(task_t t);
1359 #endif /* CONFIG_MEMORYSTATUS */
1360 extern void task_ledger_settle(task_t t);
1361 
1362 #if CONFIG_ARCADE
1363 extern void task_prep_arcade(task_t task, thread_t thread);
1364 #endif /* CONFIG_ARCADE */
1365 
1366 extern int task_pid(task_t task);
1367 
1368 #if __has_feature(ptrauth_calls)
1369 char *task_get_vm_shared_region_id_and_jop_pid(task_t task, uint64_t *);
1370 void task_set_shared_region_id(task_t task, char *id);
1371 #endif /* __has_feature(ptrauth_calls) */
1372 
1373 extern boolean_t task_has_assertions(task_t task);
1374 /* End task_policy */
1375 
1376 extern void      task_set_gpu_role(task_t task, darwin_gpu_role_t gpu_role);
1377 extern boolean_t task_is_gpu_denied(task_t task);
1378 /* Returns PRIO_DARWIN_GPU values defined in sys/resource_private.h */
1379 extern darwin_gpu_role_t      task_get_gpu_role(task_t task);
1380 
1381 extern void task_set_game_mode(task_t task, bool enabled);
1382 /* returns true if update must be pushed to coalition (Automatically handled by task_set_game_mode) */
1383 extern bool task_set_game_mode_locked(task_t task, bool enabled);
1384 extern bool task_get_game_mode(task_t task);
1385 
1386 extern void task_set_carplay_mode(task_t task, bool enabled);
1387 /* returns true if update must be pushed to coalition (Automatically handled by task_set_carplay_mode) */
1388 extern bool task_set_carplay_mode_locked(task_t task, bool enabled);
1389 extern bool task_get_carplay_mode(task_t task);
1390 
1391 extern queue_head_t * task_io_user_clients(task_t task);
1392 extern void     task_set_message_app_suspended(task_t task, boolean_t enable);
1393 
1394 extern void task_copy_fields_for_exec(task_t dst_task, task_t src_task);
1395 
1396 extern void task_copy_vmobjects(task_t task, vm_object_query_t query, size_t len, size_t *num);
1397 extern void task_get_owned_vmobjects(task_t task, size_t buffer_size, vmobject_list_output_t buffer, size_t* output_size, size_t* entries);
1398 
1399 extern void task_set_filter_msg_flag(task_t task, boolean_t flag);
1400 extern boolean_t task_get_filter_msg_flag(task_t task);
1401 
1402 #if __has_feature(ptrauth_calls)
1403 extern bool task_is_pac_exception_fatal(task_t task);
1404 extern void task_set_pac_exception_fatal_flag(task_t task);
1405 #endif /*__has_feature(ptrauth_calls)*/
1406 
1407 extern bool task_is_jit_exception_fatal(task_t task);
1408 extern void task_set_jit_flags(task_t task);
1409 
1410 extern bool task_needs_user_signed_thread_state(task_t task);
1411 extern void task_set_tecs(task_t task);
1412 extern void task_get_corpse_vmobject_list(task_t task, vmobject_list_output_t* list, size_t* list_size);
1413 
1414 extern boolean_t task_corpse_forking_disabled(task_t task);
1415 
1416 void __attribute__((noinline)) SENDING_NOTIFICATION__THIS_PROCESS_HAS_TOO_MANY_MACH_PORTS(task_t task,
1417     uint32_t current_size, uint32_t soft_limit, uint32_t hard_limit);
1418 
1419 extern int get_task_cdhash(task_t task, char cdhash[CS_CDHASH_LEN]);
1420 
1421 extern boolean_t kdp_task_is_locked(task_t task);
1422 
1423 /* redeclaration from task_server.h for the sake of kern_exec.c */
1424 extern kern_return_t _kernelrpc_mach_ports_register3(
1425 	task_t                  task,
1426 	mach_port_t             port1,
1427 	mach_port_t             port2,
1428 	mach_port_t             port3);
1429 
1430 /* Kernel side prototypes for MIG routines */
1431 extern kern_return_t task_get_exception_ports(
1432 	task_t                          task,
1433 	exception_mask_t                exception_mask,
1434 	exception_mask_array_t          masks,
1435 	mach_msg_type_number_t          *CountCnt,
1436 	exception_port_array_t          ports,
1437 	exception_behavior_array_t      behaviors,
1438 	thread_state_flavor_array_t     flavors);
1439 
1440 #if CONFIG_EXCLAVES
1441 int task_add_conclave(task_t task, void *, int64_t, const char *task_conclave_id);
1442 kern_return_t task_inherit_conclave(task_t old_task, task_t new_task, void *vnode, int64_t off);
1443 kern_return_t task_launch_conclave(mach_port_name_t port);
1444 void task_clear_conclave(task_t task);
1445 void task_stop_conclave(task_t task, bool gather_crash_bt);
1446 void task_suspend_conclave(task_t task);
1447 void task_resume_conclave(task_t task);
1448 kern_return_t task_stop_conclave_upcall(void);
1449 kern_return_t task_stop_conclave_upcall_complete(void);
1450 kern_return_t task_suspend_conclave_upcall(uint64_t *, size_t);
1451 struct conclave_sharedbuffer_t;
1452 kern_return_t task_crash_info_conclave_upcall(task_t task,
1453     const struct conclave_sharedbuffer_t *shared_buf, uint32_t length);
1454 typedef struct exclaves_resource exclaves_resource_t;
1455 exclaves_resource_t *task_get_conclave(task_t task);
1456 void task_set_conclave_untaintable(task_t task);
1457 void task_add_conclave_crash_info(task_t task, void *crash_info_ptr);
1458 //Changing this would also warrant a change in ConclaveSharedBuffer
1459 #define CONCLAVE_CRASH_BUFFER_PAGECOUNT 2
1460 
1461 #endif /* CONFIG_EXCLAVES */
1462 
1463 #endif  /* XNU_KERNEL_PRIVATE */
1464 #ifdef  KERNEL_PRIVATE
1465 
1466 extern void     *get_bsdtask_info(task_t);
1467 extern void     *get_bsdthreadtask_info(thread_t);
1468 extern void task_bsdtask_kill(task_t);
1469 extern vm_map_t get_task_map(task_t);
1470 extern ledger_t get_task_ledger(task_t);
1471 
1472 extern boolean_t get_task_pidsuspended(task_t);
1473 extern boolean_t get_task_suspended(task_t);
1474 extern boolean_t get_task_frozen(task_t);
1475 
1476 /*
1477  * Flavors of convert_task_to_port. XNU callers get convert_task_to_port_kernel,
1478  * external callers get convert_task_to_port_external.
1479  */
1480 extern ipc_port_t convert_task_to_port(task_t);
1481 extern ipc_port_t convert_task_to_port_kernel(task_t);
1482 extern ipc_port_t convert_task_to_port_external(task_t);
1483 extern void       convert_task_array_to_ports(task_array_t, size_t, mach_task_flavor_t);
1484 
1485 extern ipc_port_t convert_task_read_to_port(task_t);
1486 extern ipc_port_t convert_task_read_to_port_kernel(task_read_t);
1487 extern ipc_port_t convert_task_read_to_port_external(task_t);
1488 
1489 extern ipc_port_t convert_task_inspect_to_port(task_inspect_t);
1490 extern ipc_port_t convert_task_name_to_port(task_name_t);
1491 
1492 extern ipc_port_t convert_corpse_to_port_and_nsrequest(task_t task);
1493 
1494 extern ipc_port_t convert_task_suspension_token_to_port(task_suspension_token_t task);
1495 /* Convert from a port (in this case, an SO right to a task's resume port) to a task. */
1496 extern task_suspension_token_t convert_port_to_task_suspension_token(ipc_port_t port);
1497 
1498 extern void task_suspension_send_once(ipc_port_t port);
1499 
1500 #define TASK_WRITE_IMMEDIATE                 0x1
1501 #define TASK_WRITE_DEFERRED                  0x2
1502 #define TASK_WRITE_INVALIDATED               0x4
1503 #define TASK_WRITE_METADATA                  0x8
1504 extern void     task_update_logical_writes(task_t task, uint32_t io_size, int flags, void *vp);
1505 
1506 __enum_decl(task_balance_flags_t, uint8_t, {
1507 	TASK_BALANCE_CREDIT                 = 0x1,
1508 	TASK_BALANCE_DEBIT                  = 0x2,
1509 });
1510 
1511 __enum_decl(task_physical_write_flavor_t, uint8_t, {
1512 	TASK_PHYSICAL_WRITE_METADATA        = 0x1,
1513 });
1514 extern void     task_update_physical_writes(task_t task, task_physical_write_flavor_t flavor,
1515     uint64_t io_size, task_balance_flags_t flags);
1516 
1517 #if CONFIG_SECLUDED_MEMORY
1518 extern void task_set_can_use_secluded_mem(
1519 	task_t task,
1520 	boolean_t can_use_secluded_mem);
1521 extern void task_set_could_use_secluded_mem(
1522 	task_t task,
1523 	boolean_t could_use_secluded_mem);
1524 extern void task_set_could_also_use_secluded_mem(
1525 	task_t task,
1526 	boolean_t could_also_use_secluded_mem);
1527 extern boolean_t task_can_use_secluded_mem(
1528 	task_t task,
1529 	boolean_t is_allocate);
1530 extern boolean_t task_could_use_secluded_mem(task_t task);
1531 extern boolean_t task_could_also_use_secluded_mem(task_t task);
1532 #endif /* CONFIG_SECLUDED_MEMORY */
1533 
1534 extern void task_set_darkwake_mode(task_t, boolean_t);
1535 extern boolean_t task_get_darkwake_mode(task_t);
1536 
1537 #if __arm64__
1538 extern void task_set_legacy_footprint(task_t task);
1539 extern void task_set_extra_footprint_limit(task_t task);
1540 extern void task_set_ios13extended_footprint_limit(task_t task);
1541 #endif /* __arm64__ */
1542 
1543 #if CONFIG_MACF
1544 extern struct label *get_task_crash_label(task_t task);
1545 extern void set_task_crash_label(task_t task, struct label *label);
1546 #endif /* CONFIG_MACF */
1547 
1548 /* task_find_region_details() */
1549 __options_closed_decl(find_region_details_options_t, uint32_t, {
1550 	FIND_REGION_DETAILS_OPTIONS_NONE        = 0x00000000,
1551 	FIND_REGION_DETAILS_AT_OFFSET           = 0x00000001,
1552 	FIND_REGION_DETAILS_GET_VNODE           = 0x00000002,
1553 });
1554 #define FIND_REGION_DETAILS_OPTIONS_ALL (       \
1555 	        FIND_REGION_DETAILS_AT_OFFSET | \
1556 	        FIND_REGION_DETAILS_GET_VNODE   \
1557 	        )
1558 extern int task_find_region_details(
1559 	task_t task,
1560 	vm_map_offset_t offset,
1561 	find_region_details_options_t options,
1562 	uintptr_t *vp_p, /* caller must call vnode_put(vp) when done */
1563 	uint32_t *vid_p,
1564 	bool *is_mapped_shared_p,
1565 	uint64_t *start_p,
1566 	uint64_t *len_p);
1567 
1568 
1569 #endif  /* KERNEL_PRIVATE */
1570 
1571 extern task_t   kernel_task;
1572 
1573 extern void             task_name_deallocate_mig(
1574 	task_name_t             task_name);
1575 
1576 extern void             task_policy_set_deallocate_mig(
1577 	task_policy_set_t       task_policy_set);
1578 
1579 extern void             task_policy_get_deallocate_mig(
1580 	task_policy_get_t       task_policy_get);
1581 
1582 extern void             task_inspect_deallocate_mig(
1583 	task_inspect_t          task_inspect);
1584 
1585 extern void             task_read_deallocate_mig(
1586 	task_read_t          task_read);
1587 
1588 extern void             task_suspension_token_deallocate(
1589 	task_suspension_token_t token);
1590 
1591 extern boolean_t task_self_region_footprint(void);
1592 extern void task_self_region_footprint_set(boolean_t newval);
1593 
1594 /* VM_REGION_INFO_FLAGS defined in vm_region.h */
1595 extern int task_self_region_info_flags(void);
1596 extern kern_return_t task_self_region_info_flags_set(int newval);
1597 
1598 extern void task_ledgers_footprint(ledger_t ledger,
1599     ledger_amount_t *ledger_resident,
1600     ledger_amount_t *ledger_compressed);
1601 extern void task_set_memory_ownership_transfer(
1602 	task_t task,
1603 	boolean_t value);
1604 
1605 #if DEVELOPMENT || DEBUG
1606 extern void task_set_no_footprint_for_debug(
1607 	task_t task,
1608 	boolean_t value);
1609 extern int task_get_no_footprint_for_debug(
1610 	task_t task);
1611 #endif /* DEVELOPMENT || DEBUG */
1612 
1613 #ifdef KERNEL_PRIVATE
1614 extern kern_return_t task_get_suspend_stats(task_t task, task_suspend_stats_t stats);
1615 extern kern_return_t task_get_suspend_stats_kdp(task_t task, task_suspend_stats_t stats);
1616 #endif /* KERNEL_PRIVATE*/
1617 
1618 #ifdef XNU_KERNEL_PRIVATE
1619 extern kern_return_t task_get_suspend_sources(task_t task, task_suspend_source_array_t sources);
1620 extern kern_return_t task_get_suspend_sources_kdp(task_t task, task_suspend_source_array_t sources);
1621 #endif /* XNU_KERNEL_PRIVATE */
1622 
1623 #if CONFIG_ROSETTA
1624 extern bool task_is_translated(task_t task);
1625 #endif
1626 
1627 
1628 #ifdef MACH_KERNEL_PRIVATE
1629 
1630 void task_procname(task_t task, char *buf, int size);
1631 const char *task_best_name(task_t task);
1632 
1633 #endif /* MACH_KERNEL_PRIVATE */
1634 
1635 #if HAS_MTE
1636 /* Must be callable from IOKit as it sometimes has need to asynchronously
1637  * terminate tasks. Takes the task lock.
1638  */
1639 void task_set_ast_mte_synthesize_mach_exception(task_t task);
1640 #endif /* HAS_MTE */
1641 
1642 
1643 #ifdef KERNEL_PRIVATE
1644 kern_return_t task_set_cs_auxiliary_info(task_t task, uint64_t info);
1645 uint64_t      task_get_cs_auxiliary_info_kdp(task_t task);
1646 #endif /* KERNEL_PRIVATE */
1647 
1648 __END_DECLS
1649 
1650 #endif  /* _KERN_TASK_H_ */
1651