1 /* 2 * Copyright (c) 2000-2018 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 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */ 29 /*- 30 * Copyright (c) 1986, 1989, 1991, 1993 31 * The Regents of the University of California. All rights reserved. 32 * (c) UNIX System Laboratories, Inc. 33 * All or some portions of this file are derived from material licensed 34 * to the University of California by American Telephone and Telegraph 35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 36 * the permission of UNIX System Laboratories, Inc. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 3. All advertising materials mentioning features or use of this software 47 * must display the following acknowledgement: 48 * This product includes software developed by the University of 49 * California, Berkeley and its contributors. 50 * 4. Neither the name of the University nor the names of its contributors 51 * may be used to endorse or promote products derived from this software 52 * without specific prior written permission. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 64 * SUCH DAMAGE. 65 * 66 * @(#)proc_internal.h 8.15 (Berkeley) 5/19/95 67 */ 68 /* 69 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce 70 * support for mandatory and extensible security protections. This notice 71 * is included in support of clause 2.2 (b) of the Apple Public License, 72 * Version 2.0. 73 */ 74 75 #ifndef _SYS_PROC_INTERNAL_H_ 76 #define _SYS_PROC_INTERNAL_H_ 77 78 #include <kern/smr.h> 79 #include <kern/kalloc.h> 80 #include <libkern/OSAtomic.h> 81 #include <sys/cdefs.h> 82 #include <sys/filedesc.h> 83 #include <sys/proc.h> 84 #include <sys/proc_ro.h> 85 #include <sys/signalvar.h> 86 #include <mach/resource_monitors.h> // command/proc_name_t 87 88 __BEGIN_DECLS 89 #include <kern/locks.h> 90 #if PSYNCH 91 #include <kern/thread_call.h> 92 #endif /* PSYNCH */ 93 __END_DECLS 94 95 #if DEBUG 96 #define __PROC_INTERNAL_DEBUG 1 97 #endif 98 99 /* 100 * The short form for various locks that protect fields in the data structures. 101 * PL = Process Lock 102 * PGL = Process Group Lock 103 * PUCL = Process User Credentials Lock 104 * PSL = Process Spin Lock 105 * LL = List Lock 106 * SL = Session Lock 107 * TTYL = TTY Lock 108 * 109 * C = constant/static 110 */ 111 struct label; 112 113 /* 114 * Flags kept in the low bits of `struct session::s_refcount` 115 */ 116 __options_decl(session_ref_bits_t, uint32_t, { 117 S_DEFAULT = 0x00, 118 S_NOCTTY = 0x01, /* Do not associate controlling tty */ 119 S_CTTYREF = 0x02, /* vnode ref taken by cttyopen */ 120 }); 121 #define SESSION_REF_BITS 4 /* 2 is enough, 4 is easier in hex */ 122 #define SESSION_REF_MASK ((1u << PGRP_REF_BITS) - 1) 123 124 #define SESSION_NULL ((struct session *)NULL) 125 126 /*! 127 * @struct session 128 * 129 * @brief 130 * Structure to keep track of process sessions 131 * 132 * @discussion 133 * Sessions hang (with +1's) from: 134 * - process groups (@c pgrp::pg_session) 135 * - ttys (@c tty::t_session) 136 * 137 * Lock ordering: TTYL > LL > SL 138 */ 139 struct session { 140 lck_mtx_t s_mlock; /* session lock */ 141 LIST_ENTRY(session) s_hash; /* (LL) hash linkage */ 142 struct proc *s_leader; /* (C) session leader */ 143 struct vnode *s_ttyvp; /* (SL) Vnode of controlling terminal */ 144 struct tty *s_ttyp; /* (SL) Controlling terminal */ 145 uint32_t s_ttyvid; /* (SL) Vnode id of the controlling terminal */ 146 pid_t s_ttypgrpid; /* (SL) tty's pgrp id */ 147 dev_t _Atomic s_ttydev; /* (SL) tty's device */ 148 pid_t s_sid; /* (C) Session ID */ 149 os_ref_atomic_t s_refcount; 150 char s_login[MAXLOGNAME]; /* (SL) Setlogin() name */ 151 }; 152 153 154 /* 155 * Flags for pg_refcnt 156 */ 157 __options_decl(pggrp_ref_bits_t, uint32_t, { 158 PGRP_REF_NONE = 0x00, 159 PGRP_REF_EMPTY = 0x01, /* the process group has no members */ 160 }); 161 #define PGRP_REF_BITS 1 162 #define PGRP_REF_MASK ((1u << PGRP_REF_BITS) - 1) 163 164 #define PGRP_NULL ((struct pgrp *)NULL) 165 166 /*! 167 * @struct pgrp 168 * 169 * @abstract 170 * Describes a process group membership. 171 * 172 * @discussion 173 * <b>locking rules</b> 174 * 175 * Process groups have a static ID (@c pg_id) and session (@c pg_session), 176 * and groups hold a reference on their session. 177 * 178 * Process group membership is protected by the @c pgrp_lock(). 179 * 180 * Lock ordering: TTYL > LL > PGL 181 * 182 * <b>lifetime</b> 183 * Process groups are refcounted, with a packed bit that tracks whether 184 * the group is orphaned (has no members), which prevents it 185 * from being looked up. 186 * 187 * Process groups are retired through @c smr_proc_task_call(). 188 * 189 * Process groups are hashed in a global hash table that can be consulted 190 * while holding the @c proc_list_lock() with @c pghash_find_locked() 191 * or using hazard pointers with @c pgrp_find(). 192 */ 193 struct pgrp { 194 union { 195 lck_mtx_t pg_mlock; /* process group lock (PGL) */ 196 struct smr_node pg_smr_node; 197 }; 198 struct smrq_slink pg_hash; /* hash chain (PLL) */ 199 LIST_HEAD(, proc) pg_members; /* group members (PGL) */ 200 struct session *pg_session; /* session (static) */ 201 pid_t pg_id; /* group ID (static) */ 202 int pg_jobc; /* # procs qualifying pgrp for job control (PGL) */ 203 os_ref_atomic_t pg_refcount; 204 os_ref_atomic_t pg_hashref; 205 }; 206 207 208 __options_decl(proc_ref_bits_t, uint32_t, { 209 P_REF_NONE = 0x00u, 210 P_REF_NEW = 0x01u, /* the proc is being initialized */ 211 P_REF_DEAD = 0x02u, /* the proc is becoming a zombie */ 212 P_REF_WILL_EXEC = 0x04u, /* see proc_refdrain_will_exec() */ 213 P_REF_IN_EXEC = 0x08u, /* see proc_refdrain_will_exec() */ 214 P_REF_DRAINING = 0x10u, /* someone is in proc_refdrain() */ 215 P_REF_SHADOW = 0x20u, /* the proc is shadow proc in exec */ 216 P_REF_PROC_HOLD = 0x40u, /* the proc has ref on the proc task combined struct */ 217 P_REF_TASK_HOLD = 0x80u, /* the task has ref on the proc task combined struct */ 218 }); 219 #define P_REF_BITS 8 220 #define P_REF_MASK ((1u << P_REF_BITS) - 1) 221 222 /* 223 * Kernel signal definitions and data structures, 224 * not exported to user programs. 225 */ 226 struct sigacts; 227 228 /* 229 * Process signal actions and state, needed only within the process 230 * (not necessarily resident). 231 */ 232 struct sigacts { 233 user_addr_t ps_sigact[NSIG]; /* disposition of signals */ 234 user_addr_t ps_trampact[NSIG]; /* disposition of signals */ 235 sigset_t ps_catchmask[NSIG]; /* signals to be blocked */ 236 sigset_t ps_sigonstack; /* signals to take on sigstack */ 237 sigset_t ps_sigintr; /* signals that interrupt syscalls */ 238 sigset_t ps_sigreset; /* signals that reset when caught */ 239 sigset_t ps_signodefer; /* signals not masked while handled */ 240 sigset_t ps_siginfo; /* signals that want SA_SIGINFO args */ 241 sigset_t ps_oldmask; /* saved mask from before sigpause */ 242 _Atomic uint32_t ps_sigreturn_validation; /* sigreturn argument validation state */ 243 int ps_flags; /* signal flags, below */ 244 int ps_sig; /* for core dump/debugger XXX */ 245 int ps_code; /* for core dump/debugger XXX */ 246 int ps_addr; /* for core dump/debugger XXX */ 247 }; 248 249 #define PROC_NULL ((struct proc *)NULL) 250 251 /*! 252 * @struct proc 253 * 254 * @brief 255 * Description of a process. 256 * 257 * @discussion 258 * This structure contains the information needed to manage a thread of 259 * control, known in UN*X as a process; it has references to substructures 260 * containing descriptions of things that the process uses, but may share 261 * with related processes. The process structure and the substructures 262 * are always addressible except for those marked "(PROC ONLY)" below, 263 * which might be addressible only on a processor on which the process 264 * is running. 265 * 266 * The lifetime of a @c proc struct begins from forkproc() and ends at 267 * proc_free(). Do not modify the @c proc struct or rely on its fields 268 * being properly initialized before forkproc(). For corpses, forkproc() 269 * is not called and the @c proc struct is never initialized. 270 */ 271 struct proc { 272 union { 273 LIST_ENTRY(proc) p_list; /* List of all processes. */ 274 struct smr_node p_smr_node; 275 }; 276 struct proc * XNU_PTRAUTH_SIGNED_PTR("proc.p_pptr") p_pptr; /* Pointer to parent process.(LL) */ 277 proc_ro_t p_proc_ro; 278 pid_t p_ppid; /* process's parent pid number */ 279 pid_t p_original_ppid; /* process's original parent pid number, doesn't change if reparented */ 280 pid_t p_pgrpid; /* process group id of the process (LL)*/ 281 uid_t p_uid; 282 gid_t p_gid; 283 uid_t p_ruid; 284 gid_t p_rgid; 285 uid_t p_svuid; 286 gid_t p_svgid; 287 pid_t p_sessionid; 288 uint64_t p_puniqueid; /* parent's unique ID - set on fork/spawn, doesn't change if reparented. */ 289 290 lck_mtx_t p_mlock; /* mutex lock for proc */ 291 pid_t p_pid; /* Process identifier for proc_find. (static)*/ 292 char p_stat; /* S* process status. (PL)*/ 293 char p_shutdownstate; 294 char p_kdebug; /* P_KDEBUG eq (CC)*/ 295 char p_btrace; /* P_BTRACE eq (CC)*/ 296 297 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp (PGL) */ 298 LIST_ENTRY(proc) p_sibling; /* List of sibling processes (LL)*/ 299 LIST_HEAD(, proc) p_children; /* Pointer to list of children (LL)*/ 300 TAILQ_HEAD(, uthread) p_uthlist; /* List of uthreads (PL) */ 301 302 struct smrq_slink p_hash; /* Hash chain (LL)*/ 303 304 #if CONFIG_PERSONAS 305 struct persona *p_persona; 306 LIST_ENTRY(proc) p_persona_list; 307 #endif 308 309 lck_mtx_t p_ucred_mlock; /* mutex lock to protect p_ucred */ 310 #if CONFIG_AUDIT 311 lck_mtx_t p_audit_mlock; /* mutex lock to protect audit sessions */ 312 #endif /* CONFIG_AUDIT */ 313 314 /* substructures: */ 315 struct filedesc p_fd; /* open files structure */ 316 struct pstats *p_stats; /* Accounting/statistics (PL) */ 317 SMR_POINTER(struct plimit *) p_limit;/* Process limits (PL) */ 318 SMR_POINTER(struct pgrp *XNU_PTRAUTH_SIGNED_PTR("proc.p_pgrp")) p_pgrp; /* Pointer to process group. (LL) */ 319 320 struct sigacts p_sigacts; 321 lck_spin_t p_slock; /* spin lock for itimer/profil protection */ 322 323 int p_siglist; /* signals captured back from threads */ 324 unsigned int p_flag; /* P_* flags. (atomic bit ops) */ 325 unsigned int p_lflag; /* local flags (PL) */ 326 unsigned int p_listflag; /* list flags (LL) */ 327 unsigned int p_ladvflag; /* local adv flags (atomic) */ 328 os_ref_atomic_t p_refcount; /* number of outstanding users */ 329 os_ref_atomic_t p_waitref; /* number of users pending transition */ 330 int p_childrencnt; /* children holding ref on parent (LL) */ 331 int p_parentref; /* children lookup ref on parent (LL) */ 332 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 333 u_int p_xstat; /* Exit status for wait; also stop signal. */ 334 int p_aio_total_count; /* all allocated AIO requests for this proc */ 335 336 #ifdef _PROC_HAS_SCHEDINFO_ 337 /* may need cleanup, not used */ 338 u_int p_estcpu; /* Time averaged value of p_cpticks.(used by aio and proc_comapre) */ 339 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime (used by aio)*/ 340 u_int p_slptime; /* used by proc_compare */ 341 #endif /* _PROC_HAS_SCHEDINFO_ */ 342 343 struct itimerval p_realtimer; /* Alarm timer. (PSL) */ 344 struct timeval p_rtime; /* Real time.(PSL) */ 345 struct itimerval p_vtimer_user; /* Virtual timers.(PSL) */ 346 struct itimerval p_vtimer_prof; /* (PSL) */ 347 348 struct timeval p_rlim_cpu; /* Remaining rlim cpu value.(PSL) */ 349 int p_debugger; /* NU 1: can exec set-bit programs if suser */ 350 boolean_t sigwait; /* indication to suspend (PL) */ 351 void *sigwait_thread; /* 'thread' holding sigwait(PL) */ 352 void *exit_thread; /* Which thread is exiting(PL) */ 353 /* Following fields are info from SIGCHLD (PL) */ 354 pid_t si_pid; /* (PL) */ 355 u_int si_status; /* (PL) */ 356 u_int si_code; /* (PL) */ 357 uid_t si_uid; /* (PL) */ 358 359 void * vm_shm; /* (SYSV SHM Lock) for sysV shared memory */ 360 int p_ractive; 361 /* cached proc-specific data required for corpse inspection */ 362 pid_t p_responsible_pid; /* pid responsible for this process */ 363 364 #if CONFIG_DTRACE 365 int p_dtrace_probes; /* (PL) are there probes for this proc? */ 366 u_int p_dtrace_count; /* (sprlock) number of DTrace tracepoints */ 367 uint8_t p_dtrace_stop; /* indicates a DTrace-desired stop */ 368 user_addr_t p_dtrace_argv; /* (write once, read only after that) */ 369 user_addr_t p_dtrace_envp; /* (write once, read only after that) */ 370 lck_mtx_t p_dtrace_sprlock; /* sun proc lock emulation */ 371 struct dtrace_ptss_page* p_dtrace_ptss_pages; /* (sprlock) list of user ptss pages */ 372 struct dtrace_ptss_page_entry* p_dtrace_ptss_free_list; /* (atomic) list of individual ptss entries */ 373 struct dtrace_helpers* p_dtrace_helpers; /* (dtrace_lock) DTrace per-proc private */ 374 struct dof_ioctl_data* p_dtrace_lazy_dofs; /* (sprlock) unloaded dof_helper_t's */ 375 #endif /* CONFIG_DTRACE */ 376 377 __xnu_struct_group(proc_forkcopy_data, p_forkcopy, { 378 u_int p_argslen; /* Length of process arguments. */ 379 int p_argc; /* saved argc for sysctl_procargs() */ 380 user_addr_t user_stack; /* where user stack was allocated */ 381 struct vnode * XNU_PTRAUTH_SIGNED_PTR("proc.p_textvp") p_textvp; /* Vnode of executable. */ 382 off_t p_textoff; /* offset in executable vnode */ 383 384 sigset_t p_sigmask; /* DEPRECATED */ 385 sigset_t p_sigignore; /* Signals being ignored. (PL) */ 386 sigset_t p_sigcatch; /* Signals being caught by user.(PL) */ 387 sigset_t p_workq_allow_sigmask; /* Signals allowed for workq threads. Updates protected by proc_lock. */ 388 389 u_char p_priority; /* (NU) Process priority. */ 390 u_char p_resv0; /* (NU) User-priority based on p_cpu and p_nice. */ 391 char p_nice; /* Process "nice" value.(PL) */ 392 u_char p_resv1; /* (NU) User-priority based on p_cpu and p_nice. */ 393 394 // types currently in sys/param.h 395 command_t p_comm; 396 proc_name_t p_name; /* can be changed by the process */ 397 uint8_t p_xhighbits; /* Stores the top byte of exit status to avoid truncation*/ 398 pid_t p_contproc; /* last PID to send us a SIGCONT (PL) */ 399 400 uint32_t p_pcaction; /* action for process control on starvation */ 401 uint8_t p_uuid[16]; /* from LC_UUID load command */ 402 403 uint8_t p_responsible_uuid[16]; /* UUID of pid responsible for this process */ 404 405 /* 406 * CPU type and subtype of binary slice executed in 407 * this process. Protected by proc lock. 408 */ 409 cpu_type_t p_cputype; 410 cpu_subtype_t p_cpusubtype; 411 }); 412 413 TAILQ_HEAD(, aio_workq_entry ) p_aio_activeq; /* active async IO requests */ 414 TAILQ_HEAD(, aio_workq_entry ) p_aio_doneq; /* completed async IO requests */ 415 416 struct klist p_klist; /* knote list (PL ?)*/ 417 418 struct rusage_superset *p_ru; /* Exit information. (PL) */ 419 thread_t p_signalholder; 420 thread_t p_transholder; 421 int p_sigwaitcnt; 422 /* DEPRECATE following field */ 423 u_short p_acflag; /* Accounting flags. */ 424 volatile u_short p_vfs_iopolicy; /* VFS iopolicy flags. (atomic bit ops) */ 425 426 user_addr_t p_threadstart; /* pthread start fn */ 427 user_addr_t p_wqthread; /* pthread workqueue fn */ 428 int p_pthsize; /* pthread size */ 429 uint32_t p_pth_tsd_offset; /* offset from pthread_t to TSD for new threads */ 430 user_addr_t p_stack_addr_hint; /* stack allocation hint for wq threads */ 431 struct workqueue *_Atomic p_wqptr; /* workq ptr */ 432 433 struct timeval p_start; /* starting time */ 434 void * p_rcall; 435 void * p_pthhash; /* pthread waitqueue hash */ 436 volatile uint64_t was_throttled __attribute__((aligned(8))); /* Counter for number of throttled I/Os */ 437 volatile uint64_t did_throttle __attribute__((aligned(8))); /* Counter for number of I/Os this proc throttled */ 438 439 #if DIAGNOSTIC 440 unsigned int p_fdlock_pc[4]; 441 unsigned int p_fdunlock_pc[4]; 442 #if SIGNAL_DEBUG 443 unsigned int lockpc[8]; 444 unsigned int unlockpc[8]; 445 #endif /* SIGNAL_DEBUG */ 446 #endif /* DIAGNOSTIC */ 447 uint64_t p_dispatchqueue_offset; 448 uint64_t p_dispatchqueue_serialno_offset; 449 uint64_t p_dispatchqueue_label_offset; 450 uint64_t p_return_to_kernel_offset; 451 uint64_t p_mach_thread_self_offset; 452 /* The offset is set to 0 if userspace is not requesting for this feature */ 453 uint64_t p_pthread_wq_quantum_offset; 454 #if VM_PRESSURE_EVENTS 455 struct timeval vm_pressure_last_notify_tstamp; 456 #endif 457 uint8_t p_crash_behavior; /* bit fields to control behavior on crash. See spawn.h POSIX_SPAWN_PANIC* */ 458 bool p_posix_spawn_failed; /* indicates that a posix_spawn failed */ 459 bool p_disallow_map_with_linking; /* used to prevent dyld's map_with_linking() usage after startup */ 460 461 #if CONFIG_MEMORYSTATUS 462 #if CONFIG_FREEZE 463 uint8_t p_memstat_freeze_skip_reason; /* memorystaus_freeze_skipped_reason_t. Protected by the freezer mutex. */ 464 #endif /* CONFIG_FREEZE */ 465 /* Fields protected by proc list lock */ 466 uint32_t p_memstat_state; /* state. Also used as a wakeup channel when the memstat's LOCKED bit changes */ 467 int32_t p_memstat_effectivepriority; /* priority after transaction state accounted for */ 468 int32_t p_memstat_requestedpriority; /* active priority */ 469 int32_t p_memstat_assertionpriority; /* assertion driven priority */ 470 uint32_t p_memstat_dirty; /* dirty state */ 471 TAILQ_ENTRY(proc) p_memstat_list; /* priority bucket link */ 472 uint64_t p_memstat_userdata; /* user state */ 473 uint64_t p_memstat_idledeadline; /* time at which process became clean */ 474 uint64_t p_memstat_idle_start; /* abstime process transitions into the idle band */ 475 uint64_t p_memstat_idle_delta; /* abstime delta spent in idle band */ 476 int32_t p_memstat_memlimit; /* cached memory limit, toggles between active and inactive limits */ 477 int32_t p_memstat_memlimit_active; /* memory limit enforced when process is in active jetsam state */ 478 int32_t p_memstat_memlimit_inactive; /* memory limit enforced when process is in inactive jetsam state */ 479 int32_t p_memstat_relaunch_flags; /* flags indicating relaunch behavior for the process */ 480 #if CONFIG_FREEZE 481 uint32_t p_memstat_freeze_sharedanon_pages; /* shared pages left behind after freeze */ 482 uint32_t p_memstat_frozen_count; 483 uint32_t p_memstat_thaw_count; 484 uint32_t p_memstat_last_thaw_interval; /* In which freezer interval was this last thawed? */ 485 #endif /* CONFIG_FREEZE */ 486 #endif /* CONFIG_MEMORYSTATUS */ 487 488 _Atomic uint32_t p_user_faults; /* count the number of user faults generated */ 489 490 uint32_t p_memlimit_increase; /* byte increase for memory limit for dyld SPI rdar://problem/49950264, structure packing 32-bit and 64-bit */ 491 492 uint64_t p_crash_behavior_deadline; /* mach_continuous_time deadline. After this timestamp p_crash_behavior is invalid */ 493 494 uint32_t p_crash_count; /* Consecutive crash count threshold */ 495 uint32_t p_throttle_timeout; /* Exponential backoff throttle */ 496 497 struct os_reason *p_exit_reason; 498 499 #if CONFIG_PROC_UDATA_STORAGE 500 uint64_t p_user_data; /* general-purpose storage for userland-provided data */ 501 #endif /* CONFIG_PROC_UDATA_STORAGE */ 502 503 char * p_subsystem_root_path; 504 }; 505 506 /* 507 * Identify a process uniquely. 508 * proc_ident's fields match 1-1 with those in struct proc. 509 */ 510 struct proc_ident { 511 uint64_t p_uniqueid; 512 pid_t p_pid; 513 int p_idversion; 514 }; 515 516 #define PGRPID_DEAD 0xdeaddead 517 518 /* p_listflag */ 519 #define P_LIST_WAITING 0x00000010 520 #define P_LIST_CHILDDRSTART 0x00000080 521 #define P_LIST_CHILDDRAINED 0x00000100 522 #define P_LIST_CHILDDRWAIT 0x00000200 523 #define P_LIST_CHILDLKWAIT 0x00000400 524 #define P_LIST_DEADPARENT 0x00000800 525 #define P_LIST_PARENTREFWAIT 0x00001000 526 #define P_LIST_EXITCOUNT 0x00100000 /* counted for process exit */ 527 528 /* local flags */ 529 #define P_LDELAYTERM 0x00000001 /* */ 530 #define P_LHASTASK 0x00000002 /* process points to a task */ 531 #define P_LTERM 0x00000004 /* */ 532 #define P_LEXIT 0x00000008 /* */ 533 #define P_LPEXIT 0x00000010 534 #define P_LTRANSCOMMIT 0x00000020 /* process is committed to trans */ 535 #define P_LINTRANSIT 0x00000040 /* process in exec or in creation */ 536 #define P_LTRANSWAIT 0x00000080 /* waiting for trans to complete */ 537 #define P_LTRACED 0x00000400 /* */ 538 #define P_LSIGEXC 0x00000800 /* */ 539 #define P_LNOATTACH 0x00001000 /* */ 540 #define P_LPPWAIT 0x00002000 /* */ 541 #define P_LPTHREADJITALLOWLIST 0x00004000 /* process has pthread JIT write function allowlist */ 542 #define P_LPTHREADJITFREEZELATE 0x00008000 /* process JIT function allowlist is frozen late */ 543 #define P_LTRACE_WAIT 0x00010000 /* wait for flag to be cleared before starting ptrace */ 544 #define P_LLIMCHANGE 0x00020000 /* process is changing its plimit (rlim_cur, rlim_max) */ 545 #define P_LLIMWAIT 0x00040000 546 #define P_LWAITED 0x00080000 547 #define P_LINSIGNAL 0x00100000 548 #define P_LCUSTOM_STACK 0x00200000 /* process is using custom stack size */ 549 #define P_LRAGE_VNODES 0x00400000 550 #define P_LREGISTER 0x00800000 /* thread start fns registered */ 551 #define P_LVMRSRCOWNER 0x01000000 /* can handle the resource ownership of */ 552 #define P_LTERM_DECRYPTFAIL 0x04000000 /* process terminating due to key failure to decrypt */ 553 #define P_LTERM_JETSAM 0x08000000 /* process is being jetsam'd */ 554 555 #define P_JETSAM_VMPAGESHORTAGE 0x00000000 /* jetsam: lowest jetsam priority proc, killed due to vm page shortage */ 556 #define P_JETSAM_VMTHRASHING 0x10000000 /* jetsam: lowest jetsam priority proc, killed due to vm thrashing */ 557 #define P_JETSAM_HIWAT 0x20000000 /* jetsam: high water mark */ 558 #define P_JETSAM_PID 0x30000000 /* jetsam: pid */ 559 #define P_JETSAM_IDLEEXIT 0x40000000 /* jetsam: idle exit */ 560 #define P_JETSAM_VNODE 0x50000000 /* jetsam: vnode kill */ 561 #define P_JETSAM_FCTHRASHING 0x60000000 /* jetsam: lowest jetsam priority proc, killed due to filecache thrashing */ 562 #define P_JETSAM_MASK 0x70000000 /* jetsam type mask */ 563 #define P_LNSPACE_RESOLVER 0x80000000 /* process is the namespace resolver */ 564 565 /* Process control state for resource starvation */ 566 #define P_PCTHROTTLE 1 567 #define P_PCSUSP 2 568 #define P_PCKILL 3 569 #define P_PCMAX 3 570 571 /* Process control action state on resrouce starvation */ 572 #define PROC_ACTION_MASK 0xffff0000; 573 #define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX) 574 #define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX) 575 #define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16))) 576 #define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p)) 577 578 /* Process exit reason macros */ 579 #define PROC_HAS_EXITREASON(p) (p->p_exit_reason != OS_REASON_NULL) 580 #define PROC_EXITREASON_FLAGS(p) p->p_exit_reason->osr_flags 581 582 /* additional process flags */ 583 #define P_LADVLOCK 0x01 584 #define P_LXBKIDLEINPROG 0x02 585 #define P_RSR 0x04 586 587 /* p_vfs_iopolicy flags */ 588 #define P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY 0x0001 589 #define P_VFS_IOPOLICY_ATIME_UPDATES 0x0002 590 #define P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES 0x0004 591 #define P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME 0x0008 592 #define P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE 0x0010 593 #define P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION 0x0020 594 #define P_VFS_IOPOLICY_IGNORE_NODE_PERMISSIONS 0x0040 595 #define P_VFS_IOPOLICY_SKIP_MTIME_UPDATE 0x0080 596 #define P_VFS_IOPOLICY_ALLOW_LOW_SPACE_WRITES 0x0100 597 #define P_VFS_IOPOLICY_DISALLOW_RW_FOR_O_EVTONLY 0x0200 598 #define P_VFS_IOPOLICY_ALTLINK 0x0400 599 #define P_VFS_IOPOLICY_NOCACHE_WRITE_FS_BLKSIZE 0x0800 600 601 #define P_VFS_IOPOLICY_INHERITED_MASK \ 602 (P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY | \ 603 P_VFS_IOPOLICY_ATIME_UPDATES | \ 604 P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES | \ 605 P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME | \ 606 P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE | \ 607 P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION | \ 608 P_VFS_IOPOLICY_IGNORE_NODE_PERMISSIONS | \ 609 P_VFS_IOPOLICY_SKIP_MTIME_UPDATE | \ 610 P_VFS_IOPOLICY_DISALLOW_RW_FOR_O_EVTONLY | \ 611 P_VFS_IOPOLICY_ALTLINK | \ 612 P_VFS_IOPOLICY_NOCACHE_WRITE_FS_BLKSIZE) 613 614 #define P_VFS_IOPOLICY_VALID_MASK \ 615 (P_VFS_IOPOLICY_INHERITED_MASK | \ 616 P_VFS_IOPOLICY_ALLOW_LOW_SPACE_WRITES) 617 618 /* process creation arguments */ 619 #define PROC_CREATE_FORK 0 /* independent child (running) */ 620 #define PROC_CREATE_SPAWN 1 /* independent child (suspended) */ 621 622 /* LP64 version of extern_proc. all pointers 623 * grow when we're dealing with a 64-bit process. 624 * WARNING - keep in sync with extern_proc 625 * but use native alignment of 64-bit process. 626 */ 627 628 #ifdef KERNEL 629 #include <sys/time.h> /* user_timeval, user_itimerval */ 630 631 /* 632 * This packing is required to ensure symmetry between userspace and kernelspace 633 * when the kernel is 64-bit and the user application is 32-bit. All currently 634 * supported ARM slices (arm64/armv7k/arm64_32) contain the same struct 635 * alignment ABI so this packing isn't needed for ARM. 636 */ 637 #if defined(__x86_64__) 638 #pragma pack(4) 639 #endif 640 struct user32_extern_proc { 641 union { 642 struct { 643 uint32_t __p_forw; /* Doubly-linked run/sleep queue. */ 644 uint32_t __p_back; 645 } p_st1; 646 struct user32_timeval __p_starttime; /* process start time */ 647 } p_un; 648 uint32_t p_vmspace; /* Address space. */ 649 uint32_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 650 int p_flag; /* P_* flags. */ 651 char p_stat; /* S* process status. */ 652 pid_t p_pid; /* Process identifier. */ 653 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 654 int p_dupfd; /* Sideways return value from fdopen. XXX */ 655 /* Mach related */ 656 uint32_t user_stack; /* where user stack was allocated */ 657 uint32_t exit_thread; /* XXX Which thread is exiting? */ 658 int p_debugger; /* allow to debug */ 659 boolean_t sigwait; /* indication to suspend */ 660 /* scheduling */ 661 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 662 int p_cpticks; /* Ticks of cpu time. */ 663 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 664 uint32_t p_wchan; /* Sleep address. */ 665 uint32_t p_wmesg; /* Reason for sleep. */ 666 u_int p_swtime; /* Time swapped in or out. */ 667 u_int p_slptime; /* Time since last blocked. */ 668 struct user32_itimerval p_realtimer; /* Alarm timer. */ 669 struct user32_timeval p_rtime; /* Real time. */ 670 u_quad_t p_uticks; /* Statclock hits in user mode. */ 671 u_quad_t p_sticks; /* Statclock hits in system mode. */ 672 u_quad_t p_iticks; /* Statclock hits processing intr. */ 673 int p_traceflag; /* Kernel trace points. */ 674 uint32_t p_tracep; /* Trace to vnode. */ 675 int p_siglist; /* DEPRECATED */ 676 uint32_t p_textvp; /* Vnode of executable. */ 677 int p_holdcnt; /* If non-zero, don't swap. */ 678 sigset_t p_sigmask; /* DEPRECATED. */ 679 sigset_t p_sigignore; /* Signals being ignored. */ 680 sigset_t p_sigcatch; /* Signals being caught by user. */ 681 u_char p_priority; /* Process priority. */ 682 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 683 char p_nice; /* Process "nice" value. */ 684 char p_comm[MAXCOMLEN + 1]; 685 uint32_t p_pgrp; /* Pointer to process group. */ 686 uint32_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 687 u_short p_xstat; /* Exit status for wait; also stop signal. */ 688 u_short p_acflag; /* Accounting flags. */ 689 uint32_t p_ru; /* Exit information. XXX */ 690 }; 691 #pragma pack() 692 struct user64_extern_proc { 693 union { 694 struct { 695 user_addr_t __p_forw; /* Doubly-linked run/sleep queue. */ 696 user_addr_t __p_back; 697 } p_st1; 698 struct user64_timeval __p_starttime; /* process start time */ 699 } p_un; 700 user_addr_t p_vmspace; /* Address space. */ 701 user_addr_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 702 int p_flag; /* P_* flags. */ 703 char p_stat; /* S* process status. */ 704 pid_t p_pid; /* Process identifier. */ 705 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 706 int p_dupfd; /* Sideways return value from fdopen. XXX */ 707 /* Mach related */ 708 user_addr_t user_stack __attribute((aligned(8))); /* where user stack was allocated */ 709 user_addr_t exit_thread; /* XXX Which thread is exiting? */ 710 int p_debugger; /* allow to debug */ 711 boolean_t sigwait; /* indication to suspend */ 712 /* scheduling */ 713 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 714 int p_cpticks; /* Ticks of cpu time. */ 715 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 716 user_addr_t p_wchan __attribute((aligned(8))); /* Sleep address. */ 717 user_addr_t p_wmesg; /* Reason for sleep. */ 718 u_int p_swtime; /* Time swapped in or out. */ 719 u_int p_slptime; /* Time since last blocked. */ 720 struct user64_itimerval p_realtimer; /* Alarm timer. */ 721 struct user64_timeval p_rtime; /* Real time. */ 722 u_quad_t p_uticks; /* Statclock hits in user mode. */ 723 u_quad_t p_sticks; /* Statclock hits in system mode. */ 724 u_quad_t p_iticks; /* Statclock hits processing intr. */ 725 int p_traceflag; /* Kernel trace points. */ 726 user_addr_t p_tracep __attribute((aligned(8))); /* Trace to vnode. */ 727 int p_siglist; /* DEPRECATED */ 728 user_addr_t p_textvp __attribute((aligned(8))); /* Vnode of executable. */ 729 int p_holdcnt; /* If non-zero, don't swap. */ 730 sigset_t p_sigmask; /* DEPRECATED. */ 731 sigset_t p_sigignore; /* Signals being ignored. */ 732 sigset_t p_sigcatch; /* Signals being caught by user. */ 733 u_char p_priority; /* Process priority. */ 734 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 735 char p_nice; /* Process "nice" value. */ 736 char p_comm[MAXCOMLEN + 1]; 737 user_addr_t p_pgrp __attribute((aligned(8))); /* Pointer to process group. */ 738 user_addr_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 739 u_short p_xstat; /* Exit status for wait; also stop signal. */ 740 u_short p_acflag; /* Accounting flags. */ 741 user_addr_t p_ru __attribute((aligned(8))); /* Exit information. XXX */ 742 }; 743 #endif /* KERNEL */ 744 745 #pragma GCC visibility push(hidden) 746 747 extern struct vfs_context vfs_context0; 748 749 /* 750 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 751 * as it is used to represent "no process group". 752 */ 753 extern int nprocs, maxproc; /* Current and max number of procs. */ 754 extern int maxprocperuid; /* Current number of procs per uid */ 755 extern int hard_maxproc; /* hard limit */ 756 extern unsigned int proc_shutdown_exitcount; 757 758 #define PID_MAX 99999 759 #define NO_PID 100000 760 extern lck_mtx_t proc_list_mlock; 761 762 #define BSD_SIMUL_EXECS 33 /* 32 , allow for rounding */ 763 #define BSD_PAGEABLE_SIZE_PER_EXEC (NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */ 764 extern int execargs_cache_size; 765 extern int execargs_free_count; 766 extern vm_offset_t * execargs_cache; 767 768 #define SESS_LEADER(p, sessp) ((sessp)->s_leader == (p)) 769 770 #define SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash]) 771 extern LIST_HEAD(sesshashhead, session) * sesshashtbl; 772 extern u_long sesshash; 773 774 extern lck_attr_t proc_lck_attr; 775 extern lck_grp_t proc_fdmlock_grp; 776 extern lck_grp_t proc_lck_grp; 777 extern lck_grp_t proc_kqhashlock_grp; 778 extern lck_grp_t proc_knhashlock_grp; 779 extern lck_grp_t proc_slock_grp; 780 extern lck_grp_t proc_mlock_grp; 781 extern lck_grp_t proc_ucred_mlock_grp; 782 extern lck_grp_t proc_dirslock_grp; 783 784 LIST_HEAD(proclist, proc); 785 extern struct proclist allproc; /* List of all processes. */ 786 extern struct proclist zombproc; /* List of zombie processes. */ 787 788 #if CONFIG_COREDUMP 789 extern const char * defaultcorefiledir; 790 extern const char * defaultdrivercorefiledir; 791 extern char corefilename[MAXPATHLEN + 1]; 792 extern char drivercorefilename[MAXPATHLEN + 1]; 793 extern int do_coredump; 794 extern int sugid_coredump; 795 #endif 796 797 __options_decl(cloneproc_flags_t, uint32_t, { 798 CLONEPROC_SPAWN = 0, 799 CLONEPROC_FORK = 0x0001, 800 CLONEPROC_INITPROC = 0x0002, 801 CLONEPROC_EXEC = 0x0004, 802 }); 803 804 extern thread_t cloneproc(task_t, coalition_t *, proc_t, cloneproc_flags_t); 805 extern struct proc * XNU_PTRAUTH_SIGNED_PTR("initproc") initproc; 806 extern void proc_lock(struct proc *); 807 extern void proc_unlock(struct proc *); 808 extern void proc_spinlock(struct proc *); 809 extern void proc_spinunlock(struct proc *); 810 extern void proc_list_lock(void); 811 extern void proc_list_unlock(void); 812 extern void proc_klist_lock(void); 813 extern void proc_klist_unlock(void); 814 extern void proc_fdlock(struct proc *); 815 extern void proc_fdlock_spin(struct proc *); 816 extern void proc_fdunlock(struct proc *); 817 extern void proc_fdlock_assert(proc_t p, int assertflags); 818 extern void proc_dirs_lock_shared(struct proc *); 819 extern void proc_dirs_unlock_shared(struct proc *); 820 extern void proc_dirs_lock_exclusive(struct proc *); 821 extern void proc_dirs_unlock_exclusive(struct proc *); 822 extern void proc_ucred_lock(struct proc *); 823 extern void proc_ucred_unlock(struct proc *); 824 extern void proc_update_creds_onproc(struct proc *, kauth_cred_t cred); 825 extern kauth_cred_t proc_ucred_locked(proc_t p); 826 extern kauth_cred_t proc_ucred_smr(proc_t p); 827 extern kauth_cred_t proc_ucred_unsafe(proc_t p) __exported; 828 #if CONFIG_COREDUMP 829 __private_extern__ int proc_core_name(const char *format, const char *name, uid_t uid, pid_t pid, 830 char *cr_name, size_t cr_name_len); 831 #endif 832 /* proc_best_name_for_pid finds a process with a given pid and copies its best name of 833 * the executable (32-byte name if it exists, otherwise the 16-byte name) to 834 * the passed in buffer. The size of the buffer is to be passed in as well. 835 */ 836 extern void proc_best_name_for_pid(int pid, char * buf, int size); 837 extern int isinferior(struct proc *, struct proc *); 838 __private_extern__ struct proc *pzfind(pid_t); /* Find zombie by id. */ 839 __private_extern__ struct proc *proc_find_zombref(pid_t); /* Find zombie by id. */ 840 __private_extern__ void proc_drop_zombref(struct proc * p); /* Find zombie by id. */ 841 842 extern size_t chgproccnt(uid_t uid, int diff); 843 extern void pinsertchild(struct proc *parent, struct proc *child, bool in_exec); 844 extern void p_reparentallchildren(proc_t old_proc, proc_t new_proc); 845 extern int setsid_internal(struct proc *p); 846 #ifndef __cplusplus 847 extern void setlogin_internal(proc_t p, const char login[static MAXLOGNAME]); 848 #endif // __cplusplus 849 extern int setgroups_internal(proc_t p, u_int gidsetsize, gid_t *gidset, uid_t gmuid); 850 extern int enterpgrp(struct proc *p, pid_t pgid, int mksess); 851 extern void fixjobc(struct proc *p, struct pgrp *pgrp, int entering); 852 extern int inferior(struct proc *p); 853 extern void resetpriority(struct proc *); 854 extern void setrunnable(struct proc *); 855 extern void setrunqueue(struct proc *); 856 extern int sleep(void *chan, int pri) __exported; 857 extern int tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int)); 858 extern int tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int)); 859 extern int exit1(struct proc *, int, int *); 860 extern int exit1_internal(struct proc *, int, int *, boolean_t, boolean_t, int); 861 extern int exit_with_reason(struct proc *, int, int *, boolean_t, boolean_t, int, struct os_reason *); 862 extern int fork1(proc_t, thread_t *, int, coalition_t *); 863 extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked); 864 865 extern bool proc_list_exited(proc_t p); 866 extern proc_t proc_find_locked(int pid); 867 extern proc_t proc_find_noref_smr(int pid); 868 extern bool proc_is_shadow(proc_t p); 869 extern proc_t proc_findthread(thread_t thread); 870 extern void proc_refdrain(proc_t); 871 extern proc_t proc_refdrain_will_exec(proc_t p); 872 extern void proc_refwake_did_exec(proc_t p); 873 extern void proc_childdrainlocked(proc_t); 874 extern void proc_childdrainstart(proc_t); 875 extern void proc_childdrainend(proc_t); 876 extern void proc_checkdeadrefs(proc_t); 877 struct proc *phash_find_locked(pid_t); 878 extern void phash_insert_locked(struct proc *); 879 extern void phash_remove_locked(struct proc *); 880 extern void phash_replace_locked(struct proc *old_proc, struct proc *new_proc); 881 extern bool pghash_exists_locked(pid_t); 882 extern void pghash_insert_locked(struct pgrp *); 883 extern struct pgrp *pgrp_find(pid_t); 884 extern void pgrp_rele(struct pgrp * pgrp); 885 extern struct session * session_find_internal(pid_t sessid); 886 extern struct pgrp *proc_pgrp(proc_t, struct session **); 887 extern struct pgrp *pgrp_leave_locked(struct proc *p); 888 extern struct pgrp *pgrp_enter_locked(struct proc *parent, struct proc *p); 889 extern struct pgrp *tty_pgrp_locked(struct tty * tp); 890 struct pgrp *pgrp_alloc(pid_t pgid, pggrp_ref_bits_t bits); 891 extern void pgrp_lock(struct pgrp * pgrp); 892 extern void pgrp_unlock(struct pgrp * pgrp); 893 extern struct session *session_find_locked(pid_t sessid); 894 extern void session_replace_leader(struct proc *old_proc, struct proc *new_proc); 895 extern struct session *session_alloc(struct proc *leader); 896 extern void session_lock(struct session * sess); 897 extern void session_unlock(struct session * sess); 898 extern struct session *session_ref(struct session *sess); 899 extern void session_rele(struct session *sess); 900 extern struct tty *session_set_tty_locked(struct session *sessp, struct tty *); 901 extern struct tty *session_clear_tty_locked(struct session *sess); 902 extern struct tty *session_tty(struct session *sess); 903 extern proc_t proc_parentholdref(proc_t); 904 extern int proc_parentdropref(proc_t, int); 905 int itimerfix(struct timeval *tv); 906 int itimerdecr(struct proc * p, struct itimerval *itp, int usec); 907 void proc_free_realitimer(proc_t proc); 908 void proc_inherit_itimers(struct proc *old_proc, struct proc *new_proc); 909 int timespec_is_valid(const struct timespec *); 910 void proc_signalstart(struct proc *, int locked); 911 void proc_signalend(struct proc *, int locked); 912 int proc_transstart(struct proc *, int locked, int non_blocking); 913 void proc_transcommit(struct proc *, int locked); 914 void proc_transend(struct proc *, int locked); 915 int proc_transwait(struct proc *, int locked); 916 struct proc *proc_ref(struct proc *p, int locked); 917 void proc_wait_release(struct proc *p); 918 void proc_knote(struct proc * p, long hint); 919 void proc_transfer_knotes(struct proc *old_proc, struct proc *new_proc); 920 void proc_knote_drain(struct proc *p); 921 void proc_setregister(proc_t p); 922 void proc_resetregister(proc_t p); 923 bool proc_get_pthread_jit_allowlist(proc_t p, bool *late_out); 924 void proc_set_pthread_jit_allowlist(proc_t p, bool late); 925 /* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */ 926 thread_t proc_thread(proc_t); 927 extern int proc_pendingsignals(proc_t, sigset_t); 928 int proc_getpcontrol(int pid, int * pcontrolp); 929 int proc_dopcontrol(proc_t p); 930 int proc_resetpcontrol(int pid); 931 #if PSYNCH 932 void pth_proc_hashinit(proc_t); 933 void pth_proc_hashdelete(proc_t); 934 void pth_global_hashinit(void); 935 extern thread_call_t psynch_thcall; 936 void psynch_wq_cleanup(__unused void * param, __unused void * param1); 937 extern lck_mtx_t * pthread_list_mlock; 938 #endif /* PSYNCH */ 939 struct uthread *current_uthread(void) __pure2; 940 941 extern void proc_set_task(proc_t, task_t); 942 extern task_t proc_get_task_raw(proc_t proc); 943 extern proc_t task_get_proc_raw(task_t task); 944 extern void proc_ref_hold_proc_task_struct(proc_t proc); 945 extern void proc_release_proc_task_struct(proc_t proc); 946 extern void task_ref_hold_proc_task_struct(task_t task); 947 extern void task_release_proc_task_struct(task_t task, proc_ro_t proc_ro); 948 extern void proc_setpidversion(proc_t, int); 949 extern uint64_t proc_getcsflags(proc_t); 950 extern void proc_csflags_update(proc_t, uint64_t); 951 extern void proc_csflags_set(proc_t, uint64_t); 952 extern void proc_csflags_clear(proc_t, uint64_t); 953 extern uint8_t *proc_syscall_filter_mask(proc_t); 954 extern void proc_syscall_filter_mask_set(proc_t, uint8_t *); 955 extern pid_t proc_getpid(proc_t); 956 extern void proc_setplatformdata(proc_t, uint32_t, uint32_t, uint32_t); 957 extern void proc_set_sigact(proc_t, int, user_addr_t); 958 extern void proc_set_trampact(proc_t, int, user_addr_t); 959 extern void proc_set_sigact_trampact(proc_t, int, user_addr_t, user_addr_t); 960 extern void proc_reset_sigact(proc_t, sigset_t); 961 extern void proc_setexecutableuuid(proc_t, const uuid_t); 962 extern const unsigned char *__counted_by(sizeof(uuid_t)) proc_executableuuid_addr(proc_t); 963 extern void proc_getresponsibleuuid(proc_t target_proc, unsigned char *__counted_by(size)responsible_uuid, unsigned long size); 964 extern void proc_setresponsibleuuid(proc_t target_proc, unsigned char *__counted_by(size)responsible_uuid, unsigned long size); 965 966 #pragma mark - process iteration 967 968 /* 969 * ALLPROC_FOREACH cannot be used to access the task, as the field may be 970 * swapped out during exec. With `proc_iterate`, find threads by iterating the 971 * `p_uthlist` field of the proc, under the `proc_lock`. 972 */ 973 974 #define ALLPROC_FOREACH(var) \ 975 LIST_FOREACH((var), &allproc, p_list) 976 977 #define ZOMBPROC_FOREACH(var) \ 978 LIST_FOREACH((var), &zombproc, p_list) 979 980 #define PGMEMBERS_FOREACH(group, var) \ 981 LIST_FOREACH((var), &((struct pgrp *)(group))->pg_members, p_pglist) 982 983 #define PCHILDREN_FOREACH(parent, var) \ 984 LIST_FOREACH((var), &(((struct proc *)(parent))->p_children), p_sibling) 985 986 typedef int (*proc_iterate_fn_t)(proc_t, void *); 987 988 /* 989 * These are the only valid return values of `callout` functions provided to 990 * process iterators. 991 * 992 * CLAIMED returns expect the caller to call proc_rele on the proc. DONE 993 * returns stop iterating processes early. 994 */ 995 #define PROC_RETURNED (0) 996 #define PROC_RETURNED_DONE (1) 997 #define PROC_CLAIMED (2) 998 #define PROC_CLAIMED_DONE (3) 999 1000 /* 1001 * pgrp_iterate walks the provided process group, calling `filterfn` with 1002 * `filterarg` for each process. For processes where `filterfn` returned 1003 * non-zero, `callout` is called with `arg`. 1004 * 1005 * `PGMEMBERS_FOREACH` might also be used under the pgrp_lock to achieve a 1006 * similar effect. 1007 */ 1008 1009 extern void pgrp_iterate(struct pgrp *pgrp, proc_iterate_fn_t callout, 1010 void *arg, bool (^filterfn)(proc_t)); 1011 1012 /* 1013 * proc_iterate walks the `allproc` and/or `zombproc` lists, calling `filterfn` 1014 * with `filterarg` for each process. For processes where `filterfn` returned 1015 * non-zero, `callout` is called with `arg`. If the `PROC_NOWAITTRANS` flag is 1016 * unset, this function waits for transitions. 1017 * 1018 * `ALLPROC_FOREACH` or `ZOMBPROC_FOREACH` might also be used under the 1019 * `proc_list_lock` to achieve a similar effect. 1020 */ 1021 #define PROC_ALLPROCLIST (1U << 0) /* walk the allproc list (processes not yet exited) */ 1022 #define PROC_ZOMBPROCLIST (1U << 1) /* walk the zombie list */ 1023 #define PROC_NOWAITTRANS (1U << 2) /* do not wait for transitions (checkdirs only) */ 1024 1025 extern void proc_iterate(unsigned int flags, proc_iterate_fn_t callout, 1026 void *arg, proc_iterate_fn_t filterfn, void *filterarg); 1027 1028 /* 1029 * proc_childrenwalk walks the children of process `p`, calling `callout` for 1030 * each one. 1031 * 1032 * `PCHILDREN_FOREACH` might also be used under the `proc_list_lock` to achieve 1033 * a similar effect. 1034 */ 1035 extern void proc_childrenwalk(proc_t p, proc_iterate_fn_t callout, void *arg); 1036 1037 /* 1038 * proc_rebootscan should only be used by kern_shutdown.c 1039 */ 1040 extern void proc_rebootscan(proc_iterate_fn_t callout, void *arg, 1041 proc_iterate_fn_t filterfn, void *filterarg); 1042 1043 pid_t dtrace_proc_selfpid(void); 1044 pid_t dtrace_proc_selfppid(void); 1045 uid_t dtrace_proc_selfruid(void); 1046 1047 os_refgrp_decl_extern(p_refgrp); 1048 KALLOC_TYPE_DECLARE(proc_stats_zone); 1049 ZONE_DECLARE_ID(ZONE_ID_PROC_TASK, struct proc); 1050 extern zone_t proc_task_zone; 1051 1052 extern struct proc_ident proc_ident(proc_t p); 1053 1054 #if CONFIG_PROC_RESOURCE_LIMITS 1055 int proc_set_filedesc_limits(proc_t p, int soft_limit, int hard_limit); 1056 int proc_set_kqworkloop_limits(proc_t p, int soft_limit, int hard_limit); 1057 #endif /* CONFIG_PROC_RESOURCE_LIMITS */ 1058 1059 /* 1060 * True if the process ignores file permissions in case it owns the 1061 * file/directory 1062 */ 1063 bool proc_ignores_node_permissions(proc_t proc); 1064 1065 #pragma GCC visibility pop 1066 #endif /* !_SYS_PROC_INTERNAL_H_ */ 1067