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 <sys/kern_sysctl.h>
107 #endif /* XNU_KERNEL_PRIVATE */
108
109 #ifdef MACH_KERNEL_PRIVATE
110
111 #include <mach/boolean.h>
112 #include <mach/port.h>
113 #include <mach/time_value.h>
114 #include <mach/message.h>
115 #include <mach/mach_param.h>
116 #include <mach/task_info.h>
117 #include <mach/exception_types.h>
118 #include <mach/vm_statistics.h>
119 #include <machine/task.h>
120
121 #if MONOTONIC
122 #include <machine/monotonic.h>
123 #endif /* MONOTONIC */
124
125 #include <kern/cpu_data.h>
126 #include <kern/queue.h>
127 #include <kern/exception.h>
128 #include <kern/locks.h>
129 #include <security/_label.h>
130 #include <ipc/ipc_port.h>
131
132 #include <kern/thread.h>
133 #include <mach/coalition.h>
134 #include <stdatomic.h>
135 #include <os/refcnt.h>
136
137 struct _cpu_time_qos_stats {
138 uint64_t cpu_time_qos_default;
139 uint64_t cpu_time_qos_maintenance;
140 uint64_t cpu_time_qos_background;
141 uint64_t cpu_time_qos_utility;
142 uint64_t cpu_time_qos_legacy;
143 uint64_t cpu_time_qos_user_initiated;
144 uint64_t cpu_time_qos_user_interactive;
145 };
146
147 struct task_writes_counters {
148 uint64_t task_immediate_writes;
149 uint64_t task_deferred_writes;
150 uint64_t task_invalidated_writes;
151 uint64_t task_metadata_writes;
152 };
153
154 struct task_watchports;
155 #include <bank/bank_internal.h>
156
157 #ifdef MACH_BSD
158 struct proc;
159 struct proc_ro;
160 #endif
161
162 struct task {
163 /* Synchronization/destruction information */
164 decl_lck_mtx_data(, lock); /* Task's lock */
165 os_refcnt_t ref_count; /* Number of references to me */
166
167 #if DEVELOPMENT || DEBUG
168 struct os_refgrp *ref_group;
169 lck_spin_t ref_group_lock;
170 #endif /* DEVELOPMENT || DEBUG */
171
172 bool active; /* Task has not been terminated */
173 bool ipc_active; /* IPC with the task ports is allowed */
174 bool halting; /* Task is being halted */
175 bool message_app_suspended; /* Let iokit know when pidsuspended */
176
177 /* Virtual timers */
178 uint32_t vtimers;
179
180 /* Globally uniqueid to identify tasks and corpses */
181 uint64_t task_uniqueid;
182
183 /* Miscellaneous */
184 vm_map_t XNU_PTRAUTH_SIGNED_PTR("task.map") map; /* Address space description */
185 queue_chain_t tasks; /* global list of tasks */
186 struct task_watchports *watchports; /* watchports passed in spawn */
187 turnstile_inheritor_t returnwait_inheritor; /* inheritor for task_wait */
188
189 #if defined(CONFIG_SCHED_MULTIQ)
190 sched_group_t sched_group;
191 #endif /* defined(CONFIG_SCHED_MULTIQ) */
192
193 /* Threads in this task */
194 queue_head_t threads;
195 struct restartable_ranges *restartable_ranges;
196
197 processor_set_t pset_hint;
198 struct affinity_space *affinity_space;
199
200 int thread_count;
201 uint32_t active_thread_count;
202 int suspend_count; /* Internal scheduling only */
203
204 /* User-visible scheduling information */
205 integer_t user_stop_count; /* outstanding stops */
206 integer_t legacy_stop_count; /* outstanding legacy stops */
207
208 int16_t priority; /* base priority for threads */
209 int16_t max_priority; /* maximum priority for threads */
210
211 integer_t importance; /* priority offset (BSD 'nice' value) */
212
213 /* Statistics */
214 uint64_t total_user_time; /* terminated threads only */
215 uint64_t total_system_time;
216 uint64_t total_ptime;
217 uint64_t total_runnable_time;
218
219 /* IPC structures */
220 decl_lck_mtx_data(, itk_lock_data);
221 /*
222 * Different flavors of task port.
223 * These flavors TASK_FLAVOR_* are defined in mach_types.h
224 */
225 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_task_ports") itk_task_ports[TASK_SELF_PORT_COUNT];
226 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_settable_self") itk_settable_self; /* a send right */
227 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_self") itk_self; /* immovable/pinned task port, does not hold right */
228 struct exception_action exc_actions[EXC_TYPES_COUNT];
229 /* a send right each valid element */
230 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_host") itk_host; /* a send right */
231 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_bootstrap") itk_bootstrap; /* a send right */
232 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_debug_control") itk_debug_control; /* send right for debugmode communications */
233 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_task_access") itk_task_access; /* and another send right */
234 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_resume") itk_resume; /* a receive right to resume this task */
235 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_registered") itk_registered[TASK_PORT_REGISTER_MAX];
236 /* all send rights */
237 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 */
238 #if CONFIG_PROC_RESOURCE_LIMITS
239 struct ipc_port * XNU_PTRAUTH_SIGNED_PTR("task.itk_resource_notify") itk_resource_notify; /* a send right to the resource notify port */
240 #endif /* CONFIG_PROC_RESOURCE_LIMITS */
241 struct ipc_space * XNU_PTRAUTH_SIGNED_PTR("task.itk_space") itk_space;
242
243 ledger_t ledger;
244 /* Synchronizer ownership information */
245 queue_head_t semaphore_list; /* list of owned semaphores */
246 int semaphores_owned; /* number of semaphores owned */
247
248 unsigned int priv_flags; /* privilege resource flags */
249 #define VM_BACKING_STORE_PRIV 0x1
250
251 MACHINE_TASK
252
253 counter_t faults; /* faults counter */
254 counter_t pageins; /* pageins counter */
255 counter_t cow_faults; /* copy on write fault counter */
256 counter_t messages_sent; /* messages sent counter */
257 counter_t messages_received; /* messages received counter */
258 uint32_t decompressions; /* decompression counter */
259 uint32_t syscalls_mach; /* mach system call counter */
260 uint32_t syscalls_unix; /* unix system call counter */
261 uint32_t c_switch; /* total context switches */
262 uint32_t p_switch; /* total processor switches */
263 uint32_t ps_switch; /* total pset switches */
264
265 #ifdef MACH_BSD
266 struct proc * XNU_PTRAUTH_SIGNED_PTR("task.bsd_info") bsd_info;
267 struct proc_ro * bsd_info_ro;
268 #endif
269 kcdata_descriptor_t corpse_info;
270 uint64_t crashed_thread_id;
271 queue_chain_t corpse_tasks;
272 #ifdef CONFIG_MACF
273 struct label * crash_label;
274 #endif
275 struct vm_shared_region *shared_region;
276 #if __has_feature(ptrauth_calls)
277 char *shared_region_id; /* determines which ptr auth key to use */
278 bool shared_region_auth_remapped; /* authenticated sections ready for use */
279 #endif /* __has_feature(ptrauth_calls) */
280 volatile uint32_t t_flags; /* general-purpose task flags protected by task_lock (TL) */
281 #define TF_NONE 0
282 #define TF_64B_ADDR 0x00000001 /* task has 64-bit addressing */
283 #define TF_64B_DATA 0x00000002 /* task has 64-bit data registers */
284 #define TF_CPUMON_WARNING 0x00000004 /* task has at least one thread in CPU usage warning zone */
285 #define TF_WAKEMON_WARNING 0x00000008 /* task is in wakeups monitor warning zone */
286 #define TF_TELEMETRY (TF_CPUMON_WARNING | TF_WAKEMON_WARNING) /* task is a telemetry participant */
287 #define TF_GPU_DENIED 0x00000010 /* task is not allowed to access the GPU */
288 #define TF_CORPSE 0x00000020 /* task is a corpse */
289 #define TF_PENDING_CORPSE 0x00000040 /* task corpse has not been reported yet */
290 #define TF_CORPSE_FORK 0x00000080 /* task is a forked corpse */
291 #define TF_PLATFORM 0x00000400 /* task is a platform binary */
292 #define TF_CA_CLIENT_WI 0x00000800 /* task has CA_CLIENT work interval */
293 #define TF_DARKWAKE_MODE 0x00001000 /* task is in darkwake mode */
294 #define TF_NO_SMT 0x00002000 /* task threads must not be paired with SMT threads */
295 #define TF_FILTER_MSG 0x00004000 /* task calls into message filter callback before sending a message */
296 #define TF_SYS_VERSION_COMPAT 0x00008000 /* shim task accesses to OS version data (macOS - app compatibility) */
297 #define TF_PAC_EXC_FATAL 0x00010000 /* task is marked a corpse if a PAC exception occurs */
298 #define TF_TECS 0x00020000 /* task threads must enable CPU security */
299 #if defined(__x86_64__)
300 #define TF_INSN_COPY_OPTOUT 0x00040000 /* task threads opt out of unhandled-fault instruction stream collection */
301 #endif
302 #define TF_COALITION_MEMBER 0x00080000 /* task is a member of a coalition */
303 #define TF_NO_CORPSE_FORKING 0x00100000 /* do not fork a corpse for this task */
304 #define TF_USE_PSET_HINT_CLUSTER_TYPE 0x00200000 /* bind task to task->pset_hint->pset_cluster_type */
305 #define TF_PAC_ENFORCE_USER_STATE 0x01000000 /* Enforce user and kernel signed thread state */
306
307 /*
308 * Task is running within a 64-bit address space.
309 */
310 #define task_has_64Bit_addr(task) \
311 (((task)->t_flags & TF_64B_ADDR) != 0)
312 #define task_set_64Bit_addr(task) \
313 ((task)->t_flags |= TF_64B_ADDR)
314 #define task_clear_64Bit_addr(task) \
315 ((task)->t_flags &= ~TF_64B_ADDR)
316
317 /*
318 * Task is using 64-bit machine state.
319 */
320 #define task_has_64Bit_data(task) \
321 (((task)->t_flags & TF_64B_DATA) != 0)
322 #define task_set_64Bit_data(task) \
323 ((task)->t_flags |= TF_64B_DATA)
324 #define task_clear_64Bit_data(task) \
325 ((task)->t_flags &= ~TF_64B_DATA)
326
327 #define task_is_a_corpse(task) \
328 (((task)->t_flags & TF_CORPSE) != 0)
329
330 #define task_set_corpse(task) \
331 ((task)->t_flags |= TF_CORPSE)
332
333 #define task_corpse_pending_report(task) \
334 (((task)->t_flags & TF_PENDING_CORPSE) != 0)
335
336 #define task_set_corpse_pending_report(task) \
337 ((task)->t_flags |= TF_PENDING_CORPSE)
338
339 #define task_clear_corpse_pending_report(task) \
340 ((task)->t_flags &= ~TF_PENDING_CORPSE)
341
342 #define task_is_a_corpse_fork(task) \
343 (((task)->t_flags & TF_CORPSE_FORK) != 0)
344
345 #define task_set_coalition_member(task) \
346 ((task)->t_flags |= TF_COALITION_MEMBER)
347
348 #define task_clear_coalition_member(task) \
349 ((task)->t_flags &= ~TF_COALITION_MEMBER)
350
351 #define task_is_coalition_member(task) \
352 (((task)->t_flags & TF_COALITION_MEMBER) != 0)
353
354 uint32_t t_procflags; /* general-purpose task flags protected by proc_lock (PL) */
355 #define TPF_NONE 0
356 #define TPF_DID_EXEC 0x00000001 /* task has been execed to a new task */
357 #define TPF_EXEC_COPY 0x00000002 /* task is the new copy of an exec */
358 #ifdef CONFIG_32BIT_TELEMETRY
359 #define TPF_LOG_32BIT_TELEMETRY 0x00000004 /* task should log identifying information */
360 #endif
361
362 #define task_did_exec_internal(task) \
363 (((task)->t_procflags & TPF_DID_EXEC) != 0)
364
365 #define task_is_exec_copy_internal(task) \
366 (((task)->t_procflags & TPF_EXEC_COPY) != 0)
367
368 uint8_t t_returnwaitflags;
369 #define TWF_NONE 0
370 #define TRW_LRETURNWAIT 0x01 /* task is waiting for fork/posix_spawn/exec to complete */
371 #define TRW_LRETURNWAITER 0x02 /* task is waiting for TRW_LRETURNWAIT to get cleared */
372
373 mach_vm_address_t all_image_info_addr; /* dyld __all_image_info */
374 mach_vm_size_t all_image_info_size; /* section location and size */
375
376 #if KPC
377 #define TASK_KPC_FORCED_ALL_CTRS 0x2 /* Bit in "t_kpc" signifying this task forced all counters */
378 uint32_t t_kpc; /* kpc flags */
379 #endif /* KPC */
380
381 boolean_t pidsuspended; /* pid_suspend called; no threads can execute */
382 boolean_t frozen; /* frozen; private resident pages committed to swap */
383 boolean_t changing_freeze_state; /* in the process of freezing or thawing */
384 uint16_t policy_ru_cpu :4,
385 policy_ru_cpu_ext :4,
386 applied_ru_cpu :4,
387 applied_ru_cpu_ext :4;
388 uint8_t rusage_cpu_flags;
389 uint8_t rusage_cpu_percentage; /* Task-wide CPU limit percentage */
390 uint8_t rusage_cpu_perthr_percentage; /* Per-thread CPU limit percentage */
391 #if MACH_ASSERT
392 int8_t suspends_outstanding; /* suspends this task performed in excess of resumes */
393 #endif
394 uint64_t rusage_cpu_interval; /* Task-wide CPU limit interval */
395 uint64_t rusage_cpu_perthr_interval; /* Per-thread CPU limit interval */
396 uint64_t rusage_cpu_deadline;
397 thread_call_t rusage_cpu_callt;
398 #if CONFIG_TASKWATCH
399 queue_head_t task_watchers; /* app state watcher threads */
400 int num_taskwatchers;
401 int watchapplying;
402 #endif /* CONFIG_TASKWATCH */
403
404 struct bank_task *bank_context; /* pointer to per task bank structure */
405
406 #if IMPORTANCE_INHERITANCE
407 struct ipc_importance_task *task_imp_base; /* Base of IPC importance chain */
408 #endif /* IMPORTANCE_INHERITANCE */
409
410 vm_extmod_statistics_data_t extmod_statistics;
411
412 struct task_requested_policy requested_policy;
413 struct task_effective_policy effective_policy;
414
415 /*
416 * Can be merged with imp_donor bits, once the IMPORTANCE_INHERITANCE macro goes away.
417 */
418 uint32_t low_mem_notified_warn :1, /* warning low memory notification is sent to the task */
419 low_mem_notified_critical :1, /* critical low memory notification is sent to the task */
420 purged_memory_warn :1, /* purgeable memory of the task is purged for warning level pressure */
421 purged_memory_critical :1, /* purgeable memory of the task is purged for critical level pressure */
422 low_mem_privileged_listener :1, /* if set, task would like to know about pressure changes before other tasks on the system */
423 mem_notify_reserved :27; /* reserved for future use */
424
425 uint32_t memlimit_is_active :1, /* if set, use active attributes, otherwise use inactive attributes */
426 memlimit_is_fatal :1, /* if set, exceeding current memlimit will prove fatal to the task */
427 memlimit_active_exc_resource :1, /* if set, suppress exc_resource exception when task exceeds active memory limit */
428 memlimit_inactive_exc_resource :1, /* if set, suppress exc_resource exception when task exceeds inactive memory limit */
429 memlimit_attrs_reserved :28; /* reserved for future use */
430
431 io_stat_info_t task_io_stats;
432
433 struct task_writes_counters task_writes_counters_internal;
434 struct task_writes_counters task_writes_counters_external;
435
436 /*
437 * The cpu_time_qos_stats fields are protected by the task lock
438 */
439 struct _cpu_time_qos_stats cpu_time_eqos_stats;
440 struct _cpu_time_qos_stats cpu_time_rqos_stats;
441
442 /* Statistics accumulated for terminated threads from this task */
443 uint32_t task_timer_wakeups_bin_1;
444 uint32_t task_timer_wakeups_bin_2;
445 uint64_t task_gpu_ns;
446 uint64_t task_energy;
447
448 #if MONOTONIC
449 /* Read and written under task_lock */
450 struct mt_task task_monotonic;
451 #endif /* MONOTONIC */
452
453 uint8_t task_can_transfer_memory_ownership;
454 #if DEVELOPMENT || DEBUG
455 uint8_t task_no_footprint_for_debug;
456 #endif
457 uint8_t task_objects_disowning;
458 uint8_t task_objects_disowned;
459 /* # of purgeable volatile VM objects owned by this task: */
460 int task_volatile_objects;
461 /* # of purgeable but not volatile VM objects owned by this task: */
462 int task_nonvolatile_objects;
463 int task_owned_objects;
464 queue_head_t task_objq;
465 decl_lck_mtx_data(, task_objq_lock); /* protects "task_objq" */
466
467 unsigned int task_thread_limit:16;
468 #if __arm64__
469 unsigned int task_legacy_footprint:1;
470 unsigned int task_extra_footprint_limit:1;
471 unsigned int task_ios13extended_footprint_limit:1;
472 #endif /* __arm64__ */
473 unsigned int task_region_footprint:1;
474 unsigned int task_has_crossed_thread_limit:1;
475 uint32_t exec_token;
476 /*
477 * A task's coalition set is "adopted" in task_create_internal
478 * and unset in task_deallocate_internal, so each array member
479 * can be referenced without the task lock.
480 * Note: these fields are protected by coalition->lock,
481 * not the task lock.
482 */
483 coalition_t coalition[COALITION_NUM_TYPES];
484 queue_chain_t task_coalition[COALITION_NUM_TYPES];
485 uint64_t dispatchqueue_offset;
486
487 #if DEVELOPMENT || DEBUG
488 boolean_t task_unnested;
489 int task_disconnected_count;
490 #endif
491
492 #if HYPERVISOR
493 void * XNU_PTRAUTH_SIGNED_PTR("task.hv_task_target") hv_task_target; /* hypervisor virtual machine object associated with this task */
494 #endif /* HYPERVISOR */
495
496 #if CONFIG_SECLUDED_MEMORY
497 uint8_t task_can_use_secluded_mem;
498 uint8_t task_could_use_secluded_mem;
499 uint8_t task_could_also_use_secluded_mem;
500 uint8_t task_suppressed_secluded;
501 #endif /* CONFIG_SECLUDED_MEMORY */
502
503 task_exc_guard_behavior_t task_exc_guard;
504
505 #define task_is_immovable(task) \
506 !!(task->task_control_port_options & TASK_CONTROL_PORT_IMMOVABLE)
507 #define task_is_pinned(task) \
508 !!(task->task_control_port_options & TASK_CONTROL_PORT_PINNED)
509
510 task_control_port_options_t task_control_port_options;
511
512 queue_head_t io_user_clients;
513
514 mach_vm_address_t mach_header_vm_address;
515
516 uint32_t loadTag; /* dext ID used for logging identity */
517 #if CONFIG_FREEZE
518 queue_head_t task_frozen_cseg_q; /* queue of csegs frozen to NAND */
519 #endif /* CONFIG_FREEZE */
520 #if CONFIG_PHYS_WRITE_ACCT
521 uint64_t task_fs_metadata_writes;
522 #endif /* CONFIG_PHYS_WRITE_ACCT */
523 uint32_t task_shared_region_slide; /* cached here to avoid locking during telemetry */
524 uuid_t task_shared_region_uuid;
525 #if CONFIG_MEMORYSTATUS
526 uint64_t memstat_dirty_start; /* last abstime transition into the dirty band or last call to task_ledger_settle_dirty_time while dirty */
527 #endif /* CONFIG_MEMORYSTATUS */
528 vmobject_list_output_t corpse_vmobject_list;
529 uint64_t corpse_vmobject_list_size;
530 };
531
532 /*
533 * EXC_GUARD default delivery behavior for optional Mach port and VM guards.
534 * Applied to new tasks at creation time.
535 */
536 extern task_exc_guard_behavior_t task_exc_guard_default;
537
538 extern kern_return_t
539 task_violated_guard(mach_exception_code_t, mach_exception_subcode_t, void *);
540
541 static inline void
task_require(struct task * task)542 task_require(struct task *task)
543 {
544 zone_id_require(ZONE_ID_TASK, sizeof(struct task), task);
545 }
546
547 #define task_lock(task) lck_mtx_lock(&(task)->lock)
548 #define task_lock_assert_owned(task) LCK_MTX_ASSERT(&(task)->lock, LCK_MTX_ASSERT_OWNED)
549 #define task_lock_try(task) lck_mtx_try_lock(&(task)->lock)
550 #define task_unlock(task) lck_mtx_unlock(&(task)->lock)
551
552 #define task_objq_lock_init(task) lck_mtx_init(&(task)->task_objq_lock, &vm_object_lck_grp, &vm_object_lck_attr)
553 #define task_objq_lock_destroy(task) lck_mtx_destroy(&(task)->task_objq_lock, &vm_object_lck_grp)
554 #define task_objq_lock(task) lck_mtx_lock(&(task)->task_objq_lock)
555 #define task_objq_lock_assert_owned(task) LCK_MTX_ASSERT(&(task)->task_objq_lock, LCK_MTX_ASSERT_OWNED)
556 #define task_objq_lock_try(task) lck_mtx_try_lock(&(task)->task_objq_lock)
557 #define task_objq_unlock(task) lck_mtx_unlock(&(task)->task_objq_lock)
558
559 #define itk_lock_init(task) lck_mtx_init(&(task)->itk_lock_data, &ipc_lck_grp, &ipc_lck_attr)
560 #define itk_lock_destroy(task) lck_mtx_destroy(&(task)->itk_lock_data, &ipc_lck_grp)
561 #define itk_lock(task) lck_mtx_lock(&(task)->itk_lock_data)
562 #define itk_unlock(task) lck_mtx_unlock(&(task)->itk_lock_data)
563
564 /* task clear return wait flags */
565 #define TCRW_CLEAR_INITIAL_WAIT 0x1
566 #define TCRW_CLEAR_FINAL_WAIT 0x2
567 #define TCRW_CLEAR_ALL_WAIT (TCRW_CLEAR_INITIAL_WAIT | TCRW_CLEAR_FINAL_WAIT)
568
569 extern kern_return_t kernel_task_create(
570 task_t task,
571 vm_offset_t map_base,
572 vm_size_t map_size,
573 task_t *child);
574
575 /* Initialize task module */
576 extern void task_init(void);
577
578 /* coalition_init() calls this to initialize ledgers before task_init() */
579 extern void init_task_ledgers(void);
580
581 extern task_t current_task(void) __pure2;
582
583 extern bool task_is_driver(task_t task);
584
585 extern lck_attr_t task_lck_attr;
586 extern lck_grp_t task_lck_grp;
587
588 struct task_watchport_elem {
589 task_t twe_task;
590 ipc_port_t twe_port; /* (Space lock) */
591 ipc_port_t XNU_PTRAUTH_SIGNED_PTR("twe_pdrequest") twe_pdrequest;
592 };
593
594 struct task_watchports {
595 os_refcnt_t tw_refcount; /* (Space lock) */
596 task_t tw_task; /* (Space lock) & tw_refcount == 0 */
597 thread_t tw_thread; /* (Space lock) & tw_refcount == 0 */
598 uint32_t tw_elem_array_count; /* (Space lock) */
599 struct task_watchport_elem tw_elem[]; /* (Space lock) & (Portlock) & (mq lock) */
600 };
601
602 #define task_watchports_retain(x) (os_ref_retain(&(x)->tw_refcount))
603 #define task_watchports_release(x) (os_ref_release(&(x)->tw_refcount))
604
605 #define task_watchport_elem_init(elem, task, port) \
606 do { \
607 (elem)->twe_task = (task); \
608 (elem)->twe_port = (port); \
609 (elem)->twe_pdrequest = IP_NULL; \
610 } while(0)
611
612 #define task_watchport_elem_clear(elem) task_watchport_elem_init((elem), NULL, NULL)
613
614 extern void
615 task_add_turnstile_watchports(
616 task_t task,
617 thread_t thread,
618 ipc_port_t *portwatch_ports,
619 uint32_t portwatch_count);
620
621 extern void
622 task_watchport_elem_deallocate(
623 struct task_watchport_elem *watchport_elem);
624
625 extern boolean_t
626 task_has_watchports(task_t task);
627
628 void
629 task_dyld_process_info_update_helper(
630 task_t task,
631 size_t active_count,
632 vm_map_address_t magic_addr,
633 ipc_port_t *release_ports,
634 size_t release_count);
635
636 extern kern_return_t
637 task_suspend2_mig(
638 task_t task,
639 task_suspension_token_t *suspend_token);
640
641 extern kern_return_t
642 task_suspend2_external(
643 task_t task,
644 task_suspension_token_t *suspend_token);
645
646 extern kern_return_t
647 task_resume2_mig(
648 task_suspension_token_t suspend_token);
649
650 extern kern_return_t
651 task_resume2_external(
652 task_suspension_token_t suspend_token);
653
654 extern void
655 task_suspension_token_deallocate_grp(
656 task_suspension_token_t suspend_token,
657 task_grp_t grp);
658
659 extern ipc_port_t
660 convert_task_to_port_with_flavor(
661 task_t task,
662 mach_task_flavor_t flavor,
663 task_grp_t grp);
664
665 extern task_t current_task_early(void) __pure2;
666
667 #else /* MACH_KERNEL_PRIVATE */
668
669 __BEGIN_DECLS
670
671 extern task_t current_task(void) __pure2;
672
673 extern bool task_is_driver(task_t task);
674
675 #define TF_NONE 0
676
677 #define TWF_NONE 0
678 #define TRW_LRETURNWAIT 0x01 /* task is waiting for fork/posix_spawn/exec to complete */
679 #define TRW_LRETURNWAITER 0x02 /* task is waiting for TRW_LRETURNWAIT to get cleared */
680
681 /* task clear return wait flags */
682 #define TCRW_CLEAR_INITIAL_WAIT 0x1
683 #define TCRW_CLEAR_FINAL_WAIT 0x2
684 #define TCRW_CLEAR_ALL_WAIT (TCRW_CLEAR_INITIAL_WAIT | TCRW_CLEAR_FINAL_WAIT)
685
686
687 #define TPF_NONE 0
688 #define TPF_EXEC_COPY 0x00000002 /* task is the new copy of an exec */
689
690
691 __END_DECLS
692
693 #endif /* MACH_KERNEL_PRIVATE */
694
695 __BEGIN_DECLS
696
697 #ifdef KERNEL_PRIVATE
698 extern boolean_t task_is_app_suspended(task_t task);
699 extern bool task_is_exotic(task_t task);
700 extern bool task_is_alien(task_t task);
701 #endif
702
703 #ifdef XNU_KERNEL_PRIVATE
704
705 /* Hold all threads in a task */
706 extern kern_return_t task_hold(
707 task_t task);
708
709 /* Wait for task to stop running, either just to get off CPU or to cease being runnable */
710 extern kern_return_t task_wait(
711 task_t task,
712 boolean_t until_not_runnable);
713
714 /* Release hold on all threads in a task */
715 extern kern_return_t task_release(
716 task_t task);
717
718 /* Suspend/resume a task where the kernel owns the suspend count */
719 extern kern_return_t task_suspend_internal( task_t task);
720 extern kern_return_t task_resume_internal( task_t task);
721
722 /* Suspends a task by placing a hold on its threads */
723 extern kern_return_t task_pidsuspend(
724 task_t task);
725
726 /* Resumes a previously paused task */
727 extern kern_return_t task_pidresume(
728 task_t task);
729
730 extern kern_return_t task_send_trace_memory(
731 task_t task,
732 uint32_t pid,
733 uint64_t uniqueid);
734
735 extern void task_remove_turnstile_watchports(
736 task_t task);
737
738 extern void task_transfer_turnstile_watchports(
739 task_t old_task,
740 task_t new_task,
741 thread_t new_thread);
742
743 #if DEVELOPMENT || DEBUG
744
745 extern kern_return_t task_disconnect_page_mappings(
746 task_t task);
747 #endif
748
749 extern void tasks_system_suspend(boolean_t suspend);
750
751 #if CONFIG_FREEZE
752
753 /* Freeze a task's resident pages */
754 extern kern_return_t task_freeze(
755 task_t task,
756 uint32_t *purgeable_count,
757 uint32_t *wired_count,
758 uint32_t *clean_count,
759 uint32_t *dirty_count,
760 uint32_t dirty_budget,
761 uint32_t *shared_count,
762 int *freezer_error_code,
763 boolean_t eval_only);
764
765 /* Thaw a currently frozen task */
766 extern kern_return_t task_thaw(
767 task_t task);
768
769 typedef enum {
770 CREDIT_TO_SWAP = 1,
771 DEBIT_FROM_SWAP = 2
772 } freezer_acct_op_t;
773
774 extern void task_update_frozen_to_swap_acct(
775 task_t task,
776 int64_t amount,
777 freezer_acct_op_t op);
778
779 #endif /* CONFIG_FREEZE */
780
781 /* Halt all other threads in the current task */
782 extern kern_return_t task_start_halt(
783 task_t task);
784
785 /* Wait for other threads to halt and free halting task resources */
786 extern void task_complete_halt(
787 task_t task);
788
789 extern kern_return_t task_terminate_internal(
790 task_t task);
791
792 struct proc_ro;
793 typedef struct proc_ro *proc_ro_t;
794
795 extern kern_return_t task_create_internal(
796 task_t parent_task,
797 proc_ro_t proc_ro,
798 coalition_t *parent_coalitions,
799 boolean_t inherit_memory,
800 boolean_t is_64bit,
801 boolean_t is_64bit_data,
802 uint32_t flags,
803 uint32_t procflags,
804 uint8_t t_returnwaitflags,
805 task_t *child_task); /* OUT */
806
807 extern kern_return_t task_set_special_port_internal(
808 task_t task,
809 int which,
810 ipc_port_t port);
811
812 extern kern_return_t task_set_security_tokens(
813 task_t task,
814 security_token_t sec_token,
815 audit_token_t audit_token,
816 host_priv_t host_priv);
817
818 extern kern_return_t task_info(
819 task_t task,
820 task_flavor_t flavor,
821 task_info_t task_info_out,
822 mach_msg_type_number_t *task_info_count);
823
824 extern void task_power_info_locked(
825 task_t task,
826 task_power_info_t info,
827 gpu_energy_data_t gpu_energy,
828 task_power_info_v2_t infov2,
829 uint64_t *runnable_time);
830
831 extern uint64_t task_gpu_utilisation(
832 task_t task);
833
834 extern uint64_t task_energy(
835 task_t task);
836
837 extern uint64_t task_cpu_ptime(
838 task_t task);
839 extern void task_update_cpu_time_qos_stats(
840 task_t task,
841 uint64_t *eqos_stats,
842 uint64_t *rqos_stats);
843
844 extern void task_vtimer_set(
845 task_t task,
846 integer_t which);
847
848 extern void task_vtimer_clear(
849 task_t task,
850 integer_t which);
851
852 extern void task_vtimer_update(
853 task_t task,
854 integer_t which,
855 uint32_t *microsecs);
856
857 #define TASK_VTIMER_USER 0x01
858 #define TASK_VTIMER_PROF 0x02
859 #define TASK_VTIMER_RLIM 0x04
860
861 extern void task_set_64bit(
862 task_t task,
863 boolean_t is_64bit,
864 boolean_t is_64bit_data);
865
866 extern bool task_get_64bit_addr(
867 task_t task);
868
869 extern bool task_get_64bit_data(
870 task_t task);
871
872 extern void task_set_platform_binary(
873 task_t task,
874 boolean_t is_platform);
875
876 extern void task_set_exc_guard_ctrl_port_default(
877 task_t task,
878 thread_t main_thread,
879 const char *name,
880 unsigned int namelen,
881 boolean_t is_simulated,
882 uint32_t platform,
883 uint32_t sdk);
884
885 extern void task_set_immovable_pinned(task_t task);
886
887 extern bool task_set_ca_client_wi(
888 task_t task,
889 boolean_t ca_client_wi);
890
891 extern void task_set_dyld_info(
892 task_t task,
893 mach_vm_address_t addr,
894 mach_vm_size_t size);
895
896 extern void task_set_mach_header_address(
897 task_t task,
898 mach_vm_address_t addr);
899
900 extern void task_set_uniqueid(task_t task);
901
902 /* Get number of activations in a task */
903 extern int get_task_numacts(
904 task_t task);
905
906 struct label;
907 extern kern_return_t task_collect_crash_info(
908 task_t task,
909 #if CONFIG_MACF
910 struct label *crash_label,
911 #endif
912 int is_corpse_fork);
913
914 void task_wait_till_threads_terminate_locked(task_t task);
915
916 /* JMM - should just be temporary (implementation in bsd_kern still) */
917 extern void set_bsdtask_info(task_t, void *);
918 extern uint32_t set_task_loadTag(task_t task, uint32_t loadTag);
919 extern vm_map_t get_task_map_reference(task_t);
920 extern vm_map_t swap_task_map(task_t, thread_t, vm_map_t);
921 extern pmap_t get_task_pmap(task_t);
922 extern uint64_t get_task_resident_size(task_t);
923 extern uint64_t get_task_compressed(task_t);
924 extern uint64_t get_task_resident_max(task_t);
925 extern uint64_t get_task_phys_footprint(task_t);
926 #if CONFIG_LEDGER_INTERVAL_MAX
927 extern uint64_t get_task_phys_footprint_interval_max(task_t, int reset);
928 #endif /* CONFIG_FOOTPRINT_INTERVAL_MAX */
929 extern uint64_t get_task_phys_footprint_lifetime_max(task_t);
930 extern uint64_t get_task_phys_footprint_limit(task_t);
931 extern uint64_t get_task_purgeable_size(task_t);
932 extern uint64_t get_task_cpu_time(task_t);
933 extern uint64_t get_task_dispatchqueue_offset(task_t);
934 extern uint64_t get_task_dispatchqueue_serialno_offset(task_t);
935 extern uint64_t get_task_dispatchqueue_label_offset(task_t);
936 extern uint64_t get_task_uniqueid(task_t task);
937 extern int get_task_version(task_t task);
938
939 extern uint64_t get_task_internal(task_t);
940 extern uint64_t get_task_internal_compressed(task_t);
941 extern uint64_t get_task_purgeable_nonvolatile(task_t);
942 extern uint64_t get_task_purgeable_nonvolatile_compressed(task_t);
943 extern uint64_t get_task_iokit_mapped(task_t);
944 extern uint64_t get_task_alternate_accounting(task_t);
945 extern uint64_t get_task_alternate_accounting_compressed(task_t);
946 extern uint64_t get_task_memory_region_count(task_t);
947 extern uint64_t get_task_page_table(task_t);
948 #if CONFIG_FREEZE
949 extern uint64_t get_task_frozen_to_swap(task_t);
950 #endif
951 extern uint64_t get_task_network_nonvolatile(task_t);
952 extern uint64_t get_task_network_nonvolatile_compressed(task_t);
953 extern uint64_t get_task_wired_mem(task_t);
954 extern uint32_t get_task_loadTag(task_t task);
955
956 extern uint64_t get_task_tagged_footprint(task_t task);
957 extern uint64_t get_task_tagged_footprint_compressed(task_t task);
958 extern uint64_t get_task_media_footprint(task_t task);
959 extern uint64_t get_task_media_footprint_compressed(task_t task);
960 extern uint64_t get_task_graphics_footprint(task_t task);
961 extern uint64_t get_task_graphics_footprint_compressed(task_t task);
962 extern uint64_t get_task_neural_footprint(task_t task);
963 extern uint64_t get_task_neural_footprint_compressed(task_t task);
964
965 extern kern_return_t task_convert_phys_footprint_limit(int, int *);
966 extern kern_return_t task_set_phys_footprint_limit_internal(task_t, int, int *, boolean_t, boolean_t);
967 extern kern_return_t task_get_phys_footprint_limit(task_t task, int *limit_mb);
968
969 extern security_token_t *task_get_sec_token(task_t task);
970 extern void task_set_sec_token(task_t task, security_token_t *token);
971 extern audit_token_t *task_get_audit_token(task_t task);
972 extern void task_set_audit_token(task_t task, audit_token_t *token);
973 extern void task_set_tokens(task_t task, security_token_t *sec_token, audit_token_t *audit_token);
974 extern boolean_t task_is_privileged(task_t task);
975 extern uint8_t *task_get_mach_trap_filter_mask(task_t task);
976 extern void task_set_mach_trap_filter_mask(task_t task, uint8_t *mask);
977 extern uint8_t *task_get_mach_kobj_filter_mask(task_t task);
978 extern void task_set_mach_kobj_filter_mask(task_t task, uint8_t *mask);
979 extern void task_copy_filter_masks(task_t new_task, task_t old_task);
980
981 /* Jetsam memlimit attributes */
982 extern boolean_t task_get_memlimit_is_active(task_t task);
983 extern boolean_t task_get_memlimit_is_fatal(task_t task);
984 extern void task_set_memlimit_is_active(task_t task, boolean_t memlimit_is_active);
985 extern void task_set_memlimit_is_fatal(task_t task, boolean_t memlimit_is_fatal);
986 extern boolean_t task_has_triggered_exc_resource(task_t task, boolean_t memlimit_is_active);
987 extern void task_mark_has_triggered_exc_resource(task_t task, boolean_t memlimit_is_active);
988
989 extern uint64_t task_get_dirty_start(task_t task);
990 extern void task_set_dirty_start(task_t task, uint64_t start);
991
992 extern void task_set_thread_limit(task_t task, uint16_t thread_limit);
993 #if CONFIG_PROC_RESOURCE_LIMITS
994 extern kern_return_t task_set_port_space_limits(task_t task, uint32_t soft_limit, uint32_t hard_limit);
995 #endif /* CONFIG_PROC_RESOURCE_LIMITS */
996 extern void task_port_space_ast(task_t task);
997
998 #if XNU_TARGET_OS_OSX
999 extern boolean_t task_has_system_version_compat_enabled(task_t task);
1000 extern void task_set_system_version_compat_enabled(task_t task, boolean_t enable_system_version_compat);
1001 #endif
1002
1003 extern boolean_t is_kerneltask(task_t task);
1004 extern boolean_t is_corpsetask(task_t task);
1005 extern boolean_t is_corpsefork(task_t task);
1006
1007 extern kern_return_t check_actforsig(task_t task, thread_t thread, int setast);
1008
1009 extern kern_return_t machine_task_get_state(
1010 task_t task,
1011 int flavor,
1012 thread_state_t state,
1013 mach_msg_type_number_t *state_count);
1014
1015 extern kern_return_t machine_task_set_state(
1016 task_t task,
1017 int flavor,
1018 thread_state_t state,
1019 mach_msg_type_number_t state_count);
1020
1021 extern void machine_task_terminate(task_t task);
1022
1023 struct _task_ledger_indices {
1024 int cpu_time;
1025 int tkm_private;
1026 int tkm_shared;
1027 int phys_mem;
1028 int wired_mem;
1029 int internal;
1030 int iokit_mapped;
1031 int external;
1032 int reusable;
1033 int alternate_accounting;
1034 int alternate_accounting_compressed;
1035 int page_table;
1036 int phys_footprint;
1037 int internal_compressed;
1038 int purgeable_volatile;
1039 int purgeable_nonvolatile;
1040 int purgeable_volatile_compressed;
1041 int purgeable_nonvolatile_compressed;
1042 int tagged_nofootprint;
1043 int tagged_footprint;
1044 int tagged_nofootprint_compressed;
1045 int tagged_footprint_compressed;
1046 int network_volatile;
1047 int network_nonvolatile;
1048 int network_volatile_compressed;
1049 int network_nonvolatile_compressed;
1050 int media_nofootprint;
1051 int media_footprint;
1052 int media_nofootprint_compressed;
1053 int media_footprint_compressed;
1054 int graphics_nofootprint;
1055 int graphics_footprint;
1056 int graphics_nofootprint_compressed;
1057 int graphics_footprint_compressed;
1058 int neural_nofootprint;
1059 int neural_footprint;
1060 int neural_nofootprint_compressed;
1061 int neural_footprint_compressed;
1062 int platform_idle_wakeups;
1063 int interrupt_wakeups;
1064 #if CONFIG_SCHED_SFI
1065 int sfi_wait_times[MAX_SFI_CLASS_ID];
1066 #endif /* CONFIG_SCHED_SFI */
1067 int cpu_time_billed_to_me;
1068 int cpu_time_billed_to_others;
1069 int physical_writes;
1070 int logical_writes;
1071 int logical_writes_to_external;
1072 int energy_billed_to_me;
1073 int energy_billed_to_others;
1074 #if CONFIG_MEMORYSTATUS
1075 int memorystatus_dirty_time;
1076 #endif /* CONFIG_MEMORYSTATUS */
1077 #if DEBUG || DEVELOPMENT
1078 int pages_grabbed;
1079 int pages_grabbed_kern;
1080 int pages_grabbed_iopl;
1081 int pages_grabbed_upl;
1082 #endif
1083 #if CONFIG_FREEZE
1084 int frozen_to_swap;
1085 #endif /* CONFIG_FREEZE */
1086 #if CONFIG_PHYS_WRITE_ACCT
1087 int fs_metadata_writes;
1088 #endif /* CONFIG_PHYS_WRITE_ACCT */
1089 int swapins;
1090 };
1091
1092 /*
1093 * Many of the task ledger entries use a reduced feature set
1094 * (specifically they just use LEDGER_ENTRY_ALLOW_PANIC_ON_NEGATIVE)
1095 * and are stored in a smaller entry structure.
1096 * That structure is an implementation detail of the ledger.
1097 * But on PPL systems, the task ledger's memory is managed by the PPL
1098 * and it has to determine the size of the task ledger at compile time.
1099 * This define specifies the number of small entries so the PPL can
1100 * properly determine the ledger's size.
1101 *
1102 * If you add a new entry with only the
1103 * LEDGER_ENTRY_ALLOW_PANIC_ON_NEGATIVE | LEDGER_ENTRY_ALLOW_INACTIVE
1104 * flags, you need to increment this count.
1105 * Otherwise, PPL systems will panic at boot.
1106 */
1107 #if DEVELOPMENT || DEBUG
1108 #define TASK_LEDGER_NUM_SMALL_INDICES 33
1109 #else
1110 #define TASK_LEDGER_NUM_SMALL_INDICES 29
1111 #endif /* DEVELOPMENT || DEBUG */
1112 extern struct _task_ledger_indices task_ledgers;
1113
1114 /* requires task to be unlocked, returns a referenced thread */
1115 thread_t task_findtid(task_t task, uint64_t tid);
1116 int pid_from_task(task_t task);
1117
1118 extern kern_return_t task_wakeups_monitor_ctl(task_t task, uint32_t *rate_hz, int32_t *flags);
1119 extern kern_return_t task_cpu_usage_monitor_ctl(task_t task, uint32_t *flags);
1120 extern void task_rollup_accounting_info(task_t new_task, task_t parent_task);
1121 extern kern_return_t task_io_monitor_ctl(task_t task, uint32_t *flags);
1122 extern void task_set_did_exec_flag(task_t task);
1123 extern void task_clear_exec_copy_flag(task_t task);
1124 extern boolean_t task_is_exec_copy(task_t);
1125 extern boolean_t task_did_exec(task_t task);
1126 #ifdef CONFIG_32BIT_TELEMETRY
1127 extern boolean_t task_consume_32bit_log_flag(task_t task);
1128 extern void task_set_32bit_log_flag(task_t task);
1129 #endif /* CONFIG_32BIT_TELEMETRY */
1130 extern boolean_t task_is_active(task_t task);
1131 extern boolean_t task_is_halting(task_t task);
1132 extern void task_clear_return_wait(task_t task, uint32_t flags);
1133 extern void task_wait_to_return(void) __attribute__((noreturn));
1134 extern event_t task_get_return_wait_event(task_t task);
1135
1136 extern void task_bank_reset(task_t task);
1137 extern void task_bank_init(task_t task);
1138
1139 #if CONFIG_MEMORYSTATUS
1140 extern void task_ledger_settle_dirty_time(task_t t);
1141 #endif /* CONFIG_MEMORYSTATUS */
1142
1143 #if CONFIG_ARCADE
1144 extern void task_prep_arcade(task_t task, thread_t thread);
1145 #endif /* CONFIG_ARCADE */
1146
1147 extern int task_pid(task_t task);
1148
1149 #if __has_feature(ptrauth_calls)
1150 char *task_get_vm_shared_region_id_and_jop_pid(task_t task, uint64_t *);
1151 void task_set_shared_region_id(task_t task, char *id);
1152 #endif /* __has_feature(ptrauth_calls) */
1153
1154 extern boolean_t task_has_assertions(task_t task);
1155 /* End task_policy */
1156
1157 extern void task_set_gpu_denied(task_t task, boolean_t denied);
1158 extern boolean_t task_is_gpu_denied(task_t task);
1159
1160 extern queue_head_t * task_io_user_clients(task_t task);
1161 extern void task_set_message_app_suspended(task_t task, boolean_t enable);
1162
1163 extern void task_copy_fields_for_exec(task_t dst_task, task_t src_task);
1164
1165 extern void task_copy_vmobjects(task_t task, vm_object_query_t query, size_t len, size_t *num);
1166 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);
1167 extern void task_store_owned_vmobject_info(task_t to_task, task_t from_task);
1168
1169 extern void task_set_filter_msg_flag(task_t task, boolean_t flag);
1170 extern boolean_t task_get_filter_msg_flag(task_t task);
1171
1172 extern void task_transfer_mach_filter_bits(task_t new_task, task_t old_mask);
1173
1174 #if __has_feature(ptrauth_calls)
1175 extern bool task_is_pac_exception_fatal(task_t task);
1176 extern void task_set_pac_exception_fatal_flag(task_t task);
1177 #endif /*__has_feature(ptrauth_calls)*/
1178
1179 extern bool task_needs_user_signed_thread_state(task_t task);
1180 extern void task_set_tecs(task_t task);
1181 extern void task_get_corpse_vmobject_list(task_t task, vmobject_list_output_t* list, size_t* list_size);
1182
1183 extern boolean_t task_corpse_forking_disabled(task_t task);
1184
1185 void __attribute__((noinline)) SENDING_NOTIFICATION__THIS_PROCESS_HAS_TOO_MANY_MACH_PORTS(task_t task,
1186 uint32_t current_size, uint32_t soft_limit, uint32_t hard_limit);
1187
1188 extern int get_task_cdhash(task_t task, char cdhash[CS_CDHASH_LEN]);
1189
1190 #endif /* XNU_KERNEL_PRIVATE */
1191 #ifdef KERNEL_PRIVATE
1192
1193 extern void *get_bsdtask_info(task_t);
1194 extern void *get_bsdthreadtask_info(thread_t);
1195 extern void task_bsdtask_kill(task_t);
1196 extern vm_map_t get_task_map(task_t);
1197 extern ledger_t get_task_ledger(task_t);
1198
1199 extern boolean_t get_task_pidsuspended(task_t);
1200 extern boolean_t get_task_suspended(task_t);
1201 extern boolean_t get_task_frozen(task_t);
1202
1203 /*
1204 * Flavors of convert_task_to_port. XNU callers get convert_task_to_port_kernel,
1205 * external callers get convert_task_to_port_external, the MIG layer calls
1206 * convert_task_to_port_mig.
1207 */
1208 extern ipc_port_t convert_task_to_port(task_t);
1209 extern ipc_port_t convert_corpse_to_port_and_nsrequest(task_t task);
1210 extern ipc_port_t convert_task_to_port_pinned(task_t);
1211
1212 extern ipc_port_t convert_task_to_port_mig(task_t);
1213 extern ipc_port_t convert_task_to_port_kernel(task_t);
1214 extern ipc_port_t convert_task_to_port_external(task_t);
1215
1216 extern ipc_port_t convert_task_name_to_port(task_name_t);
1217 extern ipc_port_t convert_task_inspect_to_port(task_inspect_t);
1218 extern ipc_port_t convert_task_read_to_port(task_read_t);
1219 extern ipc_port_t convert_task_suspension_token_to_port(task_suspension_token_t task);
1220
1221
1222 /* Convert from a port (in this case, an SO right to a task's resume port) to a task. */
1223 extern task_suspension_token_t convert_port_to_task_suspension_token(ipc_port_t port);
1224 extern void task_suspension_send_once(ipc_port_t port);
1225
1226 #define TASK_WRITE_IMMEDIATE 0x1
1227 #define TASK_WRITE_DEFERRED 0x2
1228 #define TASK_WRITE_INVALIDATED 0x4
1229 #define TASK_WRITE_METADATA 0x8
1230 extern void task_update_logical_writes(task_t task, uint32_t io_size, int flags, void *vp);
1231
1232 __enum_decl(task_balance_flags_t, uint8_t, {
1233 TASK_BALANCE_CREDIT = 0x1,
1234 TASK_BALANCE_DEBIT = 0x2,
1235 });
1236
1237 __enum_decl(task_physical_write_flavor_t, uint8_t, {
1238 TASK_PHYSICAL_WRITE_METADATA = 0x1,
1239 });
1240 extern void task_update_physical_writes(task_t task, task_physical_write_flavor_t flavor,
1241 uint64_t io_size, task_balance_flags_t flags);
1242
1243 #if CONFIG_SECLUDED_MEMORY
1244 extern void task_set_can_use_secluded_mem(
1245 task_t task,
1246 boolean_t can_use_secluded_mem);
1247 extern void task_set_could_use_secluded_mem(
1248 task_t task,
1249 boolean_t could_use_secluded_mem);
1250 extern void task_set_could_also_use_secluded_mem(
1251 task_t task,
1252 boolean_t could_also_use_secluded_mem);
1253 extern boolean_t task_can_use_secluded_mem(
1254 task_t task,
1255 boolean_t is_allocate);
1256 extern boolean_t task_could_use_secluded_mem(task_t task);
1257 extern boolean_t task_could_also_use_secluded_mem(task_t task);
1258 #endif /* CONFIG_SECLUDED_MEMORY */
1259
1260 extern void task_set_darkwake_mode(task_t, boolean_t);
1261 extern boolean_t task_get_darkwake_mode(task_t);
1262
1263 #if __arm64__
1264 extern void task_set_legacy_footprint(task_t task);
1265 extern void task_set_extra_footprint_limit(task_t task);
1266 extern void task_set_ios13extended_footprint_limit(task_t task);
1267 #endif /* __arm64__ */
1268
1269 #if CONFIG_MACF
1270 extern struct label *get_task_crash_label(task_t task);
1271 extern void set_task_crash_label(task_t task, struct label *label);
1272 #endif /* CONFIG_MACF */
1273
1274 #endif /* KERNEL_PRIVATE */
1275
1276 extern task_t kernel_task;
1277
1278 extern void task_name_deallocate_mig(
1279 task_name_t task_name);
1280
1281 extern void task_policy_set_deallocate_mig(
1282 task_policy_set_t task_policy_set);
1283
1284 extern void task_policy_get_deallocate_mig(
1285 task_policy_get_t task_policy_get);
1286
1287 extern void task_inspect_deallocate_mig(
1288 task_inspect_t task_inspect);
1289
1290 extern void task_read_deallocate_mig(
1291 task_read_t task_read);
1292
1293 extern void task_suspension_token_deallocate(
1294 task_suspension_token_t token);
1295
1296 extern boolean_t task_self_region_footprint(void);
1297 extern void task_self_region_footprint_set(boolean_t newval);
1298 extern void task_ledgers_footprint(ledger_t ledger,
1299 ledger_amount_t *ledger_resident,
1300 ledger_amount_t *ledger_compressed);
1301 extern void task_set_memory_ownership_transfer(
1302 task_t task,
1303 boolean_t value);
1304
1305 #if DEVELOPMENT || DEBUG
1306 extern void task_set_no_footprint_for_debug(
1307 task_t task,
1308 boolean_t value);
1309 extern int task_get_no_footprint_for_debug(
1310 task_t task);
1311 #endif /* DEVELOPMENT || DEBUG */
1312
1313
1314 __END_DECLS
1315
1316 #endif /* _KERN_TASK_H_ */
1317