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