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