osfmk/kern/task.h

   1 /*
   2  * Copyright (c) 2000-2010, 2015 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  Software.Distribution@CS.CMU.EDU
  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 csl-dist@cs.utah.edu 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 <mach/mach_types.h>
  96 #include <sys/cdefs.h>
  97
  98 #ifdef XNU_KERNEL_PRIVATE
  99 #include <kern/kern_cdata.h>
 100 #include <mach/sfi_class.h>
 101 #include <kern/queue.h>
 102 #endif /* XNU_KERNEL_PRIVATE */
 103
 104 #ifdef  MACH_KERNEL_PRIVATE
 105
 106 #include <mach/boolean.h>
 107 #include <mach/port.h>
 108 #include <mach/time_value.h>
 109 #include <mach/message.h>
 110 #include <mach/mach_param.h>
 111 #include <mach/task_info.h>
 112 #include <mach/exception_types.h>
 113 #include <mach/vm_statistics.h>
 114 #include <machine/task.h>
 115
 116 #if MONOTONIC
 117 #include <machine/monotonic.h>
 118 #endif /* MONOTONIC */
 119
 120 #include <kern/cpu_data.h>
 121 #include <kern/queue.h>
 122 #include <kern/exception.h>
 123 #include <kern/locks.h>
 124 #include <security/_label.h>
 125 #include <ipc/ipc_port.h>
 126
 127 #include <kern/thread.h>
 128 #include <mach/coalition.h>
 129 #include <stdatomic.h>
 130
 131 #ifdef CONFIG_ATM
 132 #include <atm/atm_internal.h>
 133 #endif
 134
 135 struct _cpu_time_qos_stats {
 136         uint64_t cpu_time_qos_default;
 137         uint64_t cpu_time_qos_maintenance;
 138         uint64_t cpu_time_qos_background;
 139         uint64_t cpu_time_qos_utility;
 140         uint64_t cpu_time_qos_legacy;
 141         uint64_t cpu_time_qos_user_initiated;
 142         uint64_t cpu_time_qos_user_interactive;
 143 };
 144
 145 #include <bank/bank_internal.h>
 146
 147 struct task {
 148         /* Synchronization/destruction information */
 149         decl_lck_mtx_data(,lock)                /* Task's lock */
 150         _Atomic uint32_t        ref_count;      /* Number of references to me */
 151         boolean_t       active;         /* Task has not been terminated */
 152         boolean_t       halting;        /* Task is being halted */
 153
 154         /* Miscellaneous */
 155         vm_map_t        map;            /* Address space description */
 156         queue_chain_t   tasks;  /* global list of tasks */
 157         void            *user_data;     /* Arbitrary data settable via IPC */
 158
 159 #if defined(CONFIG_SCHED_MULTIQ)
 160         sched_group_t sched_group;
 161 #endif /* defined(CONFIG_SCHED_MULTIQ) */
 162
 163         /* Threads in this task */
 164         queue_head_t            threads;
 165
 166         processor_set_t         pset_hint;
 167         struct affinity_space   *affinity_space;
 168
 169         int                     thread_count;
 170         uint32_t                active_thread_count;
 171         int                     suspend_count;  /* Internal scheduling only */
 172
 173         /* User-visible scheduling information */
 174         integer_t               user_stop_count;        /* outstanding stops */
 175         integer_t               legacy_stop_count;      /* outstanding legacy stops */
 176
 177         integer_t               priority;                       /* base priority for threads */
 178         integer_t               max_priority;           /* maximum priority for threads */
 179
 180         integer_t               importance;             /* priority offset (BSD 'nice' value) */
 181
 182         /* Task security and audit tokens */
 183         security_token_t sec_token;
 184         audit_token_t   audit_token;
 185
 186         /* Statistics */
 187         uint64_t                total_user_time;        /* terminated threads only */
 188         uint64_t                total_system_time;
 189         uint64_t                total_ptime;
 190
 191         /* Virtual timers */
 192         uint32_t                vtimers;
 193
 194         /* IPC structures */
 195         decl_lck_mtx_data(,itk_lock_data)
 196         struct ipc_port *itk_self;      /* not a right, doesn't hold ref */
 197         struct ipc_port *itk_nself;     /* not a right, doesn't hold ref */
 198         struct ipc_port *itk_sself;     /* a send right */
 199         struct exception_action exc_actions[EXC_TYPES_COUNT];
 200                                         /* a send right each valid element  */
 201         struct ipc_port *itk_host;      /* a send right */
 202         struct ipc_port *itk_bootstrap; /* a send right */
 203         struct ipc_port *itk_seatbelt;  /* a send right */
 204         struct ipc_port *itk_gssd;      /* yet another send right */
 205         struct ipc_port *itk_debug_control; /* send right for debugmode communications */
 206         struct ipc_port *itk_task_access; /* and another send right */
 207         struct ipc_port *itk_resume;    /* a receive right to resume this task */
 208         struct ipc_port *itk_registered[TASK_PORT_REGISTER_MAX];
 209                                         /* all send rights */
 210
 211         struct ipc_space *itk_space;
 212
 213         /* Synchronizer ownership information */
 214         queue_head_t    semaphore_list;         /* list of owned semaphores   */
 215         int             semaphores_owned;       /* number of semaphores owned */
 216
 217         ledger_t        ledger;
 218
 219         unsigned int    priv_flags;                     /* privilege resource flags */
 220 #define VM_BACKING_STORE_PRIV   0x1
 221
 222         MACHINE_TASK
 223
 224         integer_t faults;              /* faults counter */
 225         integer_t pageins;             /* pageins counter */
 226         integer_t cow_faults;          /* copy on write fault counter */
 227         integer_t messages_sent;       /* messages sent counter */
 228         integer_t messages_received;   /* messages received counter */
 229         integer_t syscalls_mach;       /* mach system call counter */
 230         integer_t syscalls_unix;       /* unix system call counter */
 231                 uint32_t  c_switch;                        /* total context switches */
 232                 uint32_t  p_switch;                        /* total processor switches */
 233                 uint32_t  ps_switch;               /* total pset switches */
 234
 235 #ifdef  MACH_BSD
 236         void *bsd_info;
 237 #endif
 238         kcdata_descriptor_t             corpse_info;
 239         uint64_t                        crashed_thread_id;
 240         queue_chain_t                   corpse_tasks;
 241 #ifdef CONFIG_MACF
 242         struct label *                  crash_label;
 243 #endif
 244         struct vm_shared_region         *shared_region;
 245         volatile uint32_t t_flags;                                      /* general-purpose task flags protected by task_lock (TL) */
 246 #define TF_NONE                 0
 247 #define TF_64B_ADDR             0x00000001                              /* task has 64-bit addressing */
 248 #define TF_64B_DATA             0x00000002                              /* task has 64-bit data registers */
 249 #define TF_CPUMON_WARNING       0x00000004                              /* task has at least one thread in CPU usage warning zone */
 250 #define TF_WAKEMON_WARNING      0x00000008                              /* task is in wakeups monitor warning zone */
 251 #define TF_TELEMETRY            (TF_CPUMON_WARNING | TF_WAKEMON_WARNING) /* task is a telemetry participant */
 252 #define TF_GPU_DENIED           0x00000010                              /* task is not allowed to access the GPU */
 253 #define TF_CORPSE               0x00000020                              /* task is a corpse */
 254 #define TF_PENDING_CORPSE       0x00000040                              /* task corpse has not been reported yet */
 255 #define TF_CORPSE_FORK          0x00000080                              /* task is a forked corpse */
 256 #define TF_LRETURNWAIT          0x00000100                              /* task is waiting for fork/posix_spawn/exec to complete */
 257 #define TF_LRETURNWAITER        0x00000200                              /* task is waiting for TF_LRETURNWAIT to get cleared */
 258 #define TF_PLATFORM             0x00000400                              /* task is a platform binary */
 259 #define TF_CA_CLIENT_WI         0x00000800                              /* task has CA_CLIENT work interval */
 260
 261 #define task_has_64BitAddr(task)        \
 262          (((task)->t_flags & TF_64B_ADDR) != 0)
 263 #define task_set_64BitAddr(task)        \
 264          ((task)->t_flags |= TF_64B_ADDR)
 265 #define task_clear_64BitAddr(task)      \
 266          ((task)->t_flags &= ~TF_64B_ADDR)
 267 #define task_has_64BitData(task)    \
 268          (((task)->t_flags & TF_64B_DATA) != 0)
 269
 270 #define task_is_a_corpse(task)      \
 271          (((task)->t_flags & TF_CORPSE) != 0)
 272
 273 #define task_set_corpse(task)       \
 274          ((task)->t_flags |= TF_CORPSE)
 275
 276 #define task_corpse_pending_report(task)        \
 277          (((task)->t_flags & TF_PENDING_CORPSE) != 0)
 278
 279 #define task_set_corpse_pending_report(task)       \
 280          ((task)->t_flags |= TF_PENDING_CORPSE)
 281
 282 #define task_clear_corpse_pending_report(task)       \
 283          ((task)->t_flags &= ~TF_PENDING_CORPSE)
 284
 285 #define task_is_a_corpse_fork(task)     \
 286         (((task)->t_flags & TF_CORPSE_FORK) != 0)
 287
 288         uint32_t t_procflags;                                            /* general-purpose task flags protected by proc_lock (PL) */
 289 #define TPF_NONE                 0
 290 #define TPF_DID_EXEC             0x00000001                              /* task has been execed to a new task */
 291 #define TPF_EXEC_COPY            0x00000002                              /* task is the new copy of an exec */
 292 #ifdef CONFIG_32BIT_TELEMETRY
 293 #define TPF_LOG_32BIT_TELEMETRY  0x00000004                              /* task should log identifying information */
 294 #endif
 295
 296 #define task_did_exec_internal(task)            \
 297         (((task)->t_procflags & TPF_DID_EXEC) != 0)
 298
 299 #define task_is_exec_copy_internal(task)        \
 300         (((task)->t_procflags & TPF_EXEC_COPY) != 0)
 301
 302         mach_vm_address_t       all_image_info_addr; /* dyld __all_image_info     */
 303         mach_vm_size_t          all_image_info_size; /* section location and size */
 304
 305 #if KPC
 306 #define TASK_KPC_FORCED_ALL_CTRS        0x2     /* Bit in "t_kpc" signifying this task forced all counters */
 307         uint32_t t_kpc; /* kpc flags */
 308 #endif /* KPC */
 309
 310         boolean_t pidsuspended; /* pid_suspend called; no threads can execute */
 311         boolean_t frozen;       /* frozen; private resident pages committed to swap */
 312         boolean_t changing_freeze_state;        /* in the process of freezing or thawing */
 313         uint16_t policy_ru_cpu          :4,
 314                  policy_ru_cpu_ext      :4,
 315                  applied_ru_cpu         :4,
 316                  applied_ru_cpu_ext     :4;
 317         uint8_t  rusage_cpu_flags;
 318         uint8_t  rusage_cpu_percentage;         /* Task-wide CPU limit percentage */
 319         uint64_t rusage_cpu_interval;           /* Task-wide CPU limit interval */
 320         uint8_t  rusage_cpu_perthr_percentage;  /* Per-thread CPU limit percentage */
 321         uint64_t rusage_cpu_perthr_interval;    /* Per-thread CPU limit interval */
 322         uint64_t rusage_cpu_deadline;
 323         thread_call_t rusage_cpu_callt;
 324 #if CONFIG_EMBEDDED
 325         queue_head_t    task_watchers;          /* app state watcher threads */
 326         int     num_taskwatchers;
 327         int             watchapplying;
 328 #endif /* CONFIG_EMBEDDED */
 329
 330 #if CONFIG_ATM
 331         struct atm_task_descriptor *atm_context;  /* pointer to per task atm descriptor */
 332 #endif
 333         struct bank_task *bank_context;  /* pointer to per task bank structure */
 334
 335 #if IMPORTANCE_INHERITANCE
 336         struct ipc_importance_task  *task_imp_base;     /* Base of IPC importance chain */
 337 #endif /* IMPORTANCE_INHERITANCE */
 338
 339         vm_extmod_statistics_data_t     extmod_statistics;
 340
 341 #if MACH_ASSERT
 342         int8_t          suspends_outstanding;   /* suspends this task performed in excess of resumes */
 343 #endif
 344
 345         struct task_requested_policy requested_policy;
 346         struct task_effective_policy effective_policy;
 347
 348         /*
 349          * Can be merged with imp_donor bits, once the IMPORTANCE_INHERITANCE macro goes away.
 350          */
 351         uint32_t        low_mem_notified_warn           :1,     /* warning low memory notification is sent to the task */
 352                         low_mem_notified_critical       :1,     /* critical low memory notification is sent to the task */
 353                         purged_memory_warn              :1,     /* purgeable memory of the task is purged for warning level pressure */
 354                         purged_memory_critical          :1,     /* purgeable memory of the task is purged for critical level pressure */
 355                         low_mem_privileged_listener     :1,     /* if set, task would like to know about pressure changes before other tasks on the system */
 356                         mem_notify_reserved             :27;    /* reserved for future use */
 357
 358         uint32_t memlimit_is_active                 :1, /* if set, use active attributes, otherwise use inactive attributes */
 359                 memlimit_is_fatal                   :1, /* if set, exceeding current memlimit will prove fatal to the task */
 360                 memlimit_active_exc_resource        :1, /* if set, suppress exc_resource exception when task exceeds active memory limit */
 361                 memlimit_inactive_exc_resource      :1, /* if set, suppress exc_resource exception when task exceeds inactive memory limit */
 362                 memlimit_attrs_reserved             :28; /* reserved for future use */
 363
 364         io_stat_info_t          task_io_stats;
 365         uint64_t                task_immediate_writes __attribute__((aligned(8)));
 366         uint64_t                task_deferred_writes __attribute__((aligned(8)));
 367         uint64_t                task_invalidated_writes __attribute__((aligned(8)));
 368         uint64_t                task_metadata_writes __attribute__((aligned(8)));
 369
 370         /*
 371          * The cpu_time_qos_stats fields are protected by the task lock
 372          */
 373         struct _cpu_time_qos_stats      cpu_time_eqos_stats;
 374         struct _cpu_time_qos_stats      cpu_time_rqos_stats;
 375
 376         /* Statistics accumulated for terminated threads from this task */
 377         uint32_t        task_timer_wakeups_bin_1;
 378         uint32_t        task_timer_wakeups_bin_2;
 379         uint64_t        task_gpu_ns;
 380         uint64_t        task_energy;
 381
 382 #if MONOTONIC
 383         /* Read and written under task_lock */
 384         struct mt_task task_monotonic;
 385 #endif /* MONOTONIC */
 386
 387         /* # of purgeable volatile VM objects owned by this task: */
 388         int             task_volatile_objects;
 389         /* # of purgeable but not volatile VM objects owned by this task: */
 390         int             task_nonvolatile_objects;
 391         boolean_t       task_purgeable_disowning;
 392         boolean_t       task_purgeable_disowned;
 393         queue_head_t    task_objq;
 394         decl_lck_mtx_data(,task_objq_lock) /* protects "task_objq" */
 395
 396         boolean_t       task_region_footprint;
 397
 398         /*
 399          * A task's coalition set is "adopted" in task_create_internal
 400          * and unset in task_deallocate_internal, so each array member
 401          * can be referenced without the task lock.
 402          * Note: these fields are protected by coalition->lock,
 403          *       not the task lock.
 404          */
 405         coalition_t     coalition[COALITION_NUM_TYPES];
 406         queue_chain_t   task_coalition[COALITION_NUM_TYPES];
 407         uint64_t        dispatchqueue_offset;
 408
 409 #if DEVELOPMENT || DEBUG
 410         boolean_t       task_unnested;
 411         int             task_disconnected_count;
 412 #endif
 413
 414 #if HYPERVISOR
 415         void *hv_task_target; /* hypervisor virtual machine object associated with this task */
 416 #endif /* HYPERVISOR */
 417
 418 #if CONFIG_SECLUDED_MEMORY
 419         boolean_t       task_can_use_secluded_mem;
 420         boolean_t       task_could_use_secluded_mem;
 421         boolean_t       task_could_also_use_secluded_mem;
 422 #endif /* CONFIG_SECLUDED_MEMORY */
 423
 424         queue_head_t    io_user_clients;
 425         uint32_t        exec_token;
 426 };
 427
 428 #define task_lock(task)                 lck_mtx_lock(&(task)->lock)
 429 #define task_lock_assert_owned(task)    LCK_MTX_ASSERT(&(task)->lock, LCK_MTX_ASSERT_OWNED)
 430 #define task_lock_try(task)             lck_mtx_try_lock(&(task)->lock)
 431 #define task_unlock(task)               lck_mtx_unlock(&(task)->lock)
 432
 433 #define task_objq_lock_init(task)       lck_mtx_init(&(task)->task_objq_lock, &vm_object_lck_grp, &vm_object_lck_attr)
 434 #define task_objq_lock(task)            lck_mtx_lock(&(task)->task_objq_lock)
 435 #define task_objq_lock_assert_owned(task)       LCK_MTX_ASSERT(&(task)->task_objq_lock, LCK_MTX_ASSERT_OWNED)
 436 #define task_objq_lock_try(task)        lck_mtx_try_lock(&(task)->task_objq_lock)
 437 #define task_objq_unlock(task)          lck_mtx_unlock(&(task)->task_objq_lock)
 438
 439 #define itk_lock_init(task)     lck_mtx_init(&(task)->itk_lock_data, &ipc_lck_grp, &ipc_lck_attr)
 440 #define itk_lock_destroy(task)  lck_mtx_destroy(&(task)->itk_lock_data, &ipc_lck_grp)
 441 #define itk_lock(task)          lck_mtx_lock(&(task)->itk_lock_data)
 442 #define itk_unlock(task)        lck_mtx_unlock(&(task)->itk_lock_data)
 443
 444 #define TASK_REFERENCE_LEAK_DEBUG 0
 445
 446 #if TASK_REFERENCE_LEAK_DEBUG
 447 extern void task_reference_internal(task_t task);
 448 extern uint32_t task_deallocate_internal(task_t task);
 449 #else
 450 #define task_reference_internal(task)           \
 451                         (void)atomic_fetch_add_explicit(&(task)->ref_count, 1, memory_order_relaxed)
 452
 453 #define task_deallocate_internal(task)          \
 454                         (atomic_fetch_sub_explicit(&task->ref_count, 1, memory_order_release) - 1)
 455 #endif
 456
 457 #define task_reference(task)                                    \
 458 MACRO_BEGIN                                                                             \
 459         if ((task) != TASK_NULL)                                        \
 460                 task_reference_internal(task);                  \
 461 MACRO_END
 462
 463 extern kern_return_t    kernel_task_create(
 464                                                         task_t                  task,
 465                                                         vm_offset_t             map_base,
 466                                                         vm_size_t               map_size,
 467                                                         task_t                  *child);
 468
 469 /* Initialize task module */
 470 extern void             task_init(void);
 471
 472 /* coalition_init() calls this to initialize ledgers before task_init() */
 473 extern void             init_task_ledgers(void);
 474
 475 #define current_task_fast()     (current_thread()->task)
 476 #define current_task()          current_task_fast()
 477
 478 extern lck_attr_t      task_lck_attr;
 479 extern lck_grp_t       task_lck_grp;
 480
 481 #else   /* MACH_KERNEL_PRIVATE */
 482
 483 __BEGIN_DECLS
 484
 485 extern task_t   current_task(void);
 486
 487 extern void             task_reference(task_t   task);
 488
 489 #define TF_NONE                 0
 490 #define TF_LRETURNWAIT          0x00000100                              /* task is waiting for fork/posix_spawn/exec to complete */
 491 #define TF_LRETURNWAITER        0x00000200                              /* task is waiting for TF_LRETURNWAIT to get cleared */
 492
 493 #define TPF_NONE                0
 494 #define TPF_EXEC_COPY           0x00000002                              /* task is the new copy of an exec */
 495
 496
 497 __END_DECLS
 498
 499 #endif  /* MACH_KERNEL_PRIVATE */
 500
 501 __BEGIN_DECLS
 502
 503 #ifdef  XNU_KERNEL_PRIVATE
 504
 505 /* Hold all threads in a task */
 506 extern kern_return_t    task_hold(
 507                                                         task_t          task);
 508
 509 /* Wait for task to stop running, either just to get off CPU or to cease being runnable */
 510 extern kern_return_t    task_wait(
 511                                                         task_t          task,
 512                                                         boolean_t       until_not_runnable);
 513
 514 /* Release hold on all threads in a task */
 515 extern kern_return_t    task_release(
 516                                                         task_t          task);
 517
 518 /* Suspend/resume a task where the kernel owns the suspend count */
 519 extern kern_return_t    task_suspend_internal(          task_t          task);
 520 extern kern_return_t    task_resume_internal(           task_t          task);
 521
 522 /* Suspends a task by placing a hold on its threads */
 523 extern kern_return_t    task_pidsuspend(
 524                                                         task_t          task);
 525 extern kern_return_t    task_pidsuspend_locked(
 526                                                         task_t          task);
 527
 528 /* Resumes a previously paused task */
 529 extern kern_return_t    task_pidresume(
 530                                                         task_t          task);
 531
 532 extern kern_return_t    task_send_trace_memory(
 533                                                         task_t          task,
 534                                                         uint32_t        pid,
 535                                                         uint64_t        uniqueid);
 536
 537 #if DEVELOPMENT || DEBUG
 538
 539 extern kern_return_t    task_disconnect_page_mappings(
 540                                                         task_t          task);
 541 #endif
 542
 543 extern void                     tasks_system_suspend(boolean_t suspend);
 544
 545 #if CONFIG_FREEZE
 546
 547 /* Freeze a task's resident pages */
 548 extern kern_return_t    task_freeze(
 549                                                         task_t          task,
 550                                                         uint32_t        *purgeable_count,
 551                                                         uint32_t        *wired_count,
 552                                                         uint32_t        *clean_count,
 553                                                         uint32_t        *dirty_count,
 554                                                         uint32_t        dirty_budget,
 555                                                         boolean_t       *shared,
 556                                                         boolean_t       walk_only);
 557
 558 /* Thaw a currently frozen task */
 559 extern kern_return_t    task_thaw(
 560                                                         task_t          task);
 561
 562 #endif /* CONFIG_FREEZE */
 563
 564 /* Halt all other threads in the current task */
 565 extern kern_return_t    task_start_halt(
 566                                                         task_t          task);
 567
 568 /* Wait for other threads to halt and free halting task resources */
 569 extern void             task_complete_halt(
 570                                                         task_t          task);
 571
 572 extern kern_return_t    task_terminate_internal(
 573                                                         task_t                  task);
 574
 575 extern kern_return_t    task_create_internal(
 576                                                         task_t          parent_task,
 577                                                         coalition_t     *parent_coalitions,
 578                                                         boolean_t       inherit_memory,
 579                                                         boolean_t       is_64bit,
 580                                                         uint32_t        flags,
 581                                                         uint32_t        procflags,
 582                                                         task_t          *child_task);   /* OUT */
 583
 584 extern kern_return_t    task_info(
 585                                                         task_t                  task,
 586                                                         task_flavor_t           flavor,
 587                                                         task_info_t             task_info_out,
 588                                                         mach_msg_type_number_t  *task_info_count);
 589
 590 extern void             task_power_info_locked(
 591                                                         task_t                  task,
 592                                                         task_power_info_t       info,
 593                                                         gpu_energy_data_t       gpu_energy,
 594                                                         task_power_info_v2_t    infov2);
 595
 596 extern uint64_t         task_gpu_utilisation(
 597                                                         task_t   task);
 598
 599 extern uint64_t         task_energy(
 600                                                         task_t   task);
 601
 602 extern uint64_t         task_cpu_ptime(
 603                                                         task_t   task);
 604 extern void             task_update_cpu_time_qos_stats(
 605                                                         task_t   task,
 606                                                         uint64_t *eqos_stats,
 607                                                         uint64_t *rqos_stats);
 608
 609 extern void             task_vtimer_set(
 610                                         task_t          task,
 611                                         integer_t       which);
 612
 613 extern void             task_vtimer_clear(
 614                                         task_t          task,
 615                                         integer_t       which);
 616
 617 extern void             task_vtimer_update(
 618                                         task_t          task,
 619                                         integer_t       which,
 620                                         uint32_t        *microsecs);
 621
 622 #define TASK_VTIMER_USER                0x01
 623 #define TASK_VTIMER_PROF                0x02
 624 #define TASK_VTIMER_RLIM                0x04
 625
 626 extern void             task_set_64bit(
 627                                         task_t          task,
 628                                         boolean_t       is64bit);
 629
 630 extern void     task_set_platform_binary(
 631                                         task_t task,
 632                                         boolean_t is_platform);
 633 extern bool     task_set_ca_client_wi(
 634                                         task_t task,
 635                                         boolean_t ca_client_wi);
 636
 637 extern void             task_backing_store_privileged(
 638                                         task_t          task);
 639
 640 extern void             task_set_dyld_info(
 641                                         task_t          task,
 642                                         mach_vm_address_t addr,
 643                                         mach_vm_size_t size);
 644
 645 /* Get number of activations in a task */
 646 extern int              get_task_numacts(
 647                                         task_t          task);
 648
 649 extern int get_task_numactivethreads(task_t task);
 650
 651 struct label;
 652 extern kern_return_t task_collect_crash_info(
 653                                                 task_t task,
 654 #if CONFIG_MACF
 655                                                 struct label *crash_label,
 656 #endif
 657                                                 int is_corpse_fork);
 658 void task_port_notify(mach_msg_header_t *msg);
 659 void task_wait_till_threads_terminate_locked(task_t task);
 660
 661 /* JMM - should just be temporary (implementation in bsd_kern still) */
 662 extern void     set_bsdtask_info(task_t,void *);
 663 extern vm_map_t get_task_map_reference(task_t);
 664 extern vm_map_t swap_task_map(task_t, thread_t, vm_map_t);
 665 extern pmap_t   get_task_pmap(task_t);
 666 extern uint64_t get_task_resident_size(task_t);
 667 extern uint64_t get_task_compressed(task_t);
 668 extern uint64_t get_task_resident_max(task_t);
 669 extern uint64_t get_task_phys_footprint(task_t);
 670 extern uint64_t get_task_phys_footprint_recent_max(task_t);
 671 extern uint64_t get_task_phys_footprint_lifetime_max(task_t);
 672 extern uint64_t get_task_phys_footprint_limit(task_t);
 673 extern uint64_t get_task_purgeable_size(task_t);
 674 extern uint64_t get_task_cpu_time(task_t);
 675 extern uint64_t get_task_dispatchqueue_offset(task_t);
 676 extern uint64_t get_task_dispatchqueue_serialno_offset(task_t);
 677 extern uint64_t get_task_uniqueid(task_t task);
 678 extern int      get_task_version(task_t task);
 679
 680 extern uint64_t get_task_internal(task_t);
 681 extern uint64_t get_task_internal_compressed(task_t);
 682 extern uint64_t get_task_purgeable_nonvolatile(task_t);
 683 extern uint64_t get_task_purgeable_nonvolatile_compressed(task_t);
 684 extern uint64_t get_task_iokit_mapped(task_t);
 685 extern uint64_t get_task_alternate_accounting(task_t);
 686 extern uint64_t get_task_alternate_accounting_compressed(task_t);
 687 extern uint64_t get_task_memory_region_count(task_t);
 688 extern uint64_t get_task_page_table(task_t);
 689
 690 extern kern_return_t task_convert_phys_footprint_limit(int, int *);
 691 extern kern_return_t task_set_phys_footprint_limit_internal(task_t, int, int *, boolean_t, boolean_t);
 692 extern kern_return_t task_get_phys_footprint_limit(task_t task, int *limit_mb);
 693
 694 /* Jetsam memlimit attributes */
 695 extern boolean_t task_get_memlimit_is_active(task_t task);
 696 extern boolean_t task_get_memlimit_is_fatal(task_t task);
 697 extern void task_set_memlimit_is_active(task_t task, boolean_t memlimit_is_active);
 698 extern void task_set_memlimit_is_fatal(task_t task, boolean_t memlimit_is_fatal);
 699 extern boolean_t task_has_triggered_exc_resource(task_t task, boolean_t memlimit_is_active);
 700 extern void task_mark_has_triggered_exc_resource(task_t task, boolean_t memlimit_is_active);
 701
 702 extern boolean_t        is_kerneltask(task_t task);
 703 extern boolean_t        is_corpsetask(task_t task);
 704
 705 extern kern_return_t check_actforsig(task_t task, thread_t thread, int setast);
 706
 707 extern kern_return_t machine_task_get_state(
 708                                         task_t task,
 709                                         int flavor,
 710                                         thread_state_t state,
 711                                         mach_msg_type_number_t *state_count);
 712
 713 extern kern_return_t machine_task_set_state(
 714                                         task_t task,
 715                                         int flavor,
 716                                         thread_state_t state,
 717                                         mach_msg_type_number_t state_count);
 718
 719 extern void machine_task_terminate(task_t task);
 720
 721 struct _task_ledger_indices {
 722         int cpu_time;
 723         int tkm_private;
 724         int tkm_shared;
 725         int phys_mem;
 726         int wired_mem;
 727         int internal;
 728         int iokit_mapped;
 729         int alternate_accounting;
 730         int alternate_accounting_compressed;
 731         int page_table;
 732         int phys_footprint;
 733         int internal_compressed;
 734         int purgeable_volatile;
 735         int purgeable_nonvolatile;
 736         int purgeable_volatile_compressed;
 737         int purgeable_nonvolatile_compressed;
 738         int platform_idle_wakeups;
 739         int interrupt_wakeups;
 740 #if CONFIG_SCHED_SFI
 741         int sfi_wait_times[MAX_SFI_CLASS_ID];
 742 #endif /* CONFIG_SCHED_SFI */
 743         int cpu_time_billed_to_me;
 744         int cpu_time_billed_to_others;
 745         int physical_writes;
 746         int logical_writes;
 747         int energy_billed_to_me;
 748         int energy_billed_to_others;
 749 };
 750 extern struct _task_ledger_indices task_ledgers;
 751
 752 /* requires task to be unlocked, returns a referenced thread */
 753 thread_t task_findtid(task_t task, uint64_t tid);
 754 int pid_from_task(task_t task);
 755
 756 extern kern_return_t task_wakeups_monitor_ctl(task_t task, uint32_t *rate_hz, int32_t *flags);
 757 extern kern_return_t task_cpu_usage_monitor_ctl(task_t task, uint32_t *flags);
 758 extern void task_rollup_accounting_info(task_t new_task, task_t parent_task);
 759 extern kern_return_t task_io_monitor_ctl(task_t task, uint32_t *flags);
 760 extern void task_set_did_exec_flag(task_t task);
 761 extern void task_clear_exec_copy_flag(task_t task);
 762 extern boolean_t task_is_exec_copy(task_t);
 763 extern boolean_t task_did_exec(task_t task);
 764 #ifdef CONFIG_32BIT_TELEMETRY
 765 extern boolean_t task_consume_32bit_log_flag(task_t task);
 766 extern void task_set_32bit_log_flag(task_t task);
 767 #endif /* CONFIG_32BIT_TELEMETRY */
 768 extern boolean_t task_is_active(task_t task);
 769 extern boolean_t task_is_halting(task_t task);
 770 extern void task_clear_return_wait(task_t task);
 771 extern void task_wait_to_return(void) __attribute__((noreturn));
 772 extern event_t task_get_return_wait_event(task_t task);
 773
 774 extern void task_atm_reset(task_t task);
 775 extern void task_bank_reset(task_t task);
 776 extern void task_bank_init(task_t task);
 777
 778 extern int task_pid(task_t task);
 779 extern boolean_t task_has_assertions(task_t task);
 780 /* End task_policy */
 781
 782 extern void      task_set_gpu_denied(task_t task, boolean_t denied);
 783 extern boolean_t task_is_gpu_denied(task_t task);
 784
 785 extern queue_head_t * task_io_user_clients(task_t task);
 786
 787 extern void task_copy_fields_for_exec(task_t dst_task, task_t src_task);
 788
 789 #endif  /* XNU_KERNEL_PRIVATE */
 790
 791 #ifdef  KERNEL_PRIVATE
 792
 793 extern void     *get_bsdtask_info(task_t);
 794 extern void     *get_bsdthreadtask_info(thread_t);
 795 extern void task_bsdtask_kill(task_t);
 796 extern vm_map_t get_task_map(task_t);
 797 extern ledger_t get_task_ledger(task_t);
 798
 799 extern boolean_t get_task_pidsuspended(task_t);
 800 extern boolean_t get_task_frozen(task_t);
 801
 802 /* Convert from a task to a port */
 803 extern ipc_port_t convert_task_to_port(task_t);
 804 extern ipc_port_t convert_task_name_to_port(task_name_t);
 805 extern ipc_port_t convert_task_inspect_to_port(task_inspect_t);
 806 extern ipc_port_t convert_task_suspension_token_to_port(task_suspension_token_t task);
 807
 808 /* Convert from a port (in this case, an SO right to a task's resume port) to a task. */
 809 extern task_suspension_token_t convert_port_to_task_suspension_token(ipc_port_t port);
 810
 811 extern boolean_t task_suspension_notify(mach_msg_header_t *);
 812
 813 #define TASK_WRITE_IMMEDIATE            0x1
 814 #define TASK_WRITE_DEFERRED             0x2
 815 #define TASK_WRITE_INVALIDATED          0x4
 816 #define TASK_WRITE_METADATA             0x8
 817 extern void     task_update_logical_writes(task_t task, uint32_t io_size, int flags, void *vp);
 818
 819 #if CONFIG_SECLUDED_MEMORY
 820 extern void task_set_can_use_secluded_mem(
 821         task_t task,
 822         boolean_t can_use_secluded_mem);
 823 extern void task_set_could_use_secluded_mem(
 824         task_t task,
 825         boolean_t could_use_secluded_mem);
 826 extern void task_set_could_also_use_secluded_mem(
 827         task_t task,
 828         boolean_t could_also_use_secluded_mem);
 829 extern boolean_t task_can_use_secluded_mem(task_t task);
 830 extern boolean_t task_could_use_secluded_mem(task_t task);
 831 #endif /* CONFIG_SECLUDED_MEMORY */
 832
 833 #if CONFIG_MACF
 834 extern struct label *get_task_crash_label(task_t task);
 835 #endif /* CONFIG_MACF */
 836
 837 #endif  /* KERNEL_PRIVATE */
 838
 839 extern task_t   kernel_task;
 840
 841 extern void             task_deallocate(
 842                                         task_t          task);
 843
 844 extern void             task_name_deallocate(
 845                                         task_name_t             task_name);
 846
 847 extern void             task_inspect_deallocate(
 848                                         task_inspect_t          task_inspect);
 849
 850 extern void             task_suspension_token_deallocate(
 851                                         task_suspension_token_t token);
 852
 853 extern boolean_t task_self_region_footprint(void);
 854 extern void task_self_region_footprint_set(boolean_t newval);
 855
 856 __END_DECLS
 857
 858 #endif  /* _KERN_TASK_H_ */