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 * Description of a process. 253 * 254 * This structure contains the information needed to manage a thread of 255 * control, known in UN*X as a process; it has references to substructures 256 * containing descriptions of things that the process uses, but may share 257 * with related processes. The process structure and the substructures 258 * are always addressible except for those marked "(PROC ONLY)" below, 259 * which might be addressible only on a processor on which the process 260 * is running. 261 */ 262 struct proc { 263 union { 264 LIST_ENTRY(proc) p_list; /* List of all processes. */ 265 struct smr_node p_smr_node; 266 }; 267 struct proc * XNU_PTRAUTH_SIGNED_PTR("proc.p_pptr") p_pptr; /* Pointer to parent process.(LL) */ 268 proc_ro_t p_proc_ro; 269 pid_t p_ppid; /* process's parent pid number */ 270 pid_t p_original_ppid; /* process's original parent pid number, doesn't change if reparented */ 271 pid_t p_pgrpid; /* process group id of the process (LL)*/ 272 uid_t p_uid; 273 gid_t p_gid; 274 uid_t p_ruid; 275 gid_t p_rgid; 276 uid_t p_svuid; 277 gid_t p_svgid; 278 pid_t p_sessionid; 279 uint64_t p_puniqueid; /* parent's unique ID - set on fork/spawn, doesn't change if reparented. */ 280 281 lck_mtx_t p_mlock; /* mutex lock for proc */ 282 pid_t p_pid; /* Process identifier for proc_find. (static)*/ 283 char p_stat; /* S* process status. (PL)*/ 284 char p_shutdownstate; 285 char p_kdebug; /* P_KDEBUG eq (CC)*/ 286 char p_btrace; /* P_BTRACE eq (CC)*/ 287 288 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp (PGL) */ 289 LIST_ENTRY(proc) p_sibling; /* List of sibling processes (LL)*/ 290 LIST_HEAD(, proc) p_children; /* Pointer to list of children (LL)*/ 291 TAILQ_HEAD(, uthread) p_uthlist; /* List of uthreads (PL) */ 292 293 struct smrq_slink p_hash; /* Hash chain (LL)*/ 294 295 #if CONFIG_PERSONAS 296 struct persona *p_persona; 297 LIST_ENTRY(proc) p_persona_list; 298 #endif 299 300 lck_mtx_t p_ucred_mlock; /* mutex lock to protect p_ucred */ 301 #if CONFIG_AUDIT 302 lck_mtx_t p_audit_mlock; /* mutex lock to protect audit sessions */ 303 #endif /* CONFIG_AUDIT */ 304 305 /* substructures: */ 306 struct filedesc p_fd; /* open files structure */ 307 struct pstats *p_stats; /* Accounting/statistics (PL) */ 308 SMR_POINTER(struct plimit *) p_limit;/* Process limits (PL) */ 309 SMR_POINTER(struct pgrp *XNU_PTRAUTH_SIGNED_PTR("proc.p_pgrp")) p_pgrp; /* Pointer to process group. (LL) */ 310 311 struct sigacts p_sigacts; 312 lck_spin_t p_slock; /* spin lock for itimer/profil protection */ 313 314 int p_siglist; /* signals captured back from threads */ 315 unsigned int p_flag; /* P_* flags. (atomic bit ops) */ 316 unsigned int p_lflag; /* local flags (PL) */ 317 unsigned int p_listflag; /* list flags (LL) */ 318 unsigned int p_ladvflag; /* local adv flags (atomic) */ 319 os_ref_atomic_t p_refcount; /* number of outstanding users */ 320 os_ref_atomic_t p_waitref; /* number of users pending transition */ 321 int p_childrencnt; /* children holding ref on parent (LL) */ 322 int p_parentref; /* children lookup ref on parent (LL) */ 323 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 324 u_int p_xstat; /* Exit status for wait; also stop signal. */ 325 int p_aio_total_count; /* all allocated AIO requests for this proc */ 326 327 #ifdef _PROC_HAS_SCHEDINFO_ 328 /* may need cleanup, not used */ 329 u_int p_estcpu; /* Time averaged value of p_cpticks.(used by aio and proc_comapre) */ 330 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime (used by aio)*/ 331 u_int p_slptime; /* used by proc_compare */ 332 #endif /* _PROC_HAS_SCHEDINFO_ */ 333 334 struct itimerval p_realtimer; /* Alarm timer. (PSL) */ 335 struct timeval p_rtime; /* Real time.(PSL) */ 336 struct itimerval p_vtimer_user; /* Virtual timers.(PSL) */ 337 struct itimerval p_vtimer_prof; /* (PSL) */ 338 339 struct timeval p_rlim_cpu; /* Remaining rlim cpu value.(PSL) */ 340 int p_debugger; /* NU 1: can exec set-bit programs if suser */ 341 boolean_t sigwait; /* indication to suspend (PL) */ 342 void *sigwait_thread; /* 'thread' holding sigwait(PL) */ 343 void *exit_thread; /* Which thread is exiting(PL) */ 344 /* Following fields are info from SIGCHLD (PL) */ 345 pid_t si_pid; /* (PL) */ 346 u_int si_status; /* (PL) */ 347 u_int si_code; /* (PL) */ 348 uid_t si_uid; /* (PL) */ 349 350 void * vm_shm; /* (SYSV SHM Lock) for sysV shared memory */ 351 int p_ractive; 352 /* cached proc-specific data required for corpse inspection */ 353 pid_t p_responsible_pid; /* pid resonsible for this process */ 354 355 #if CONFIG_DTRACE 356 int p_dtrace_probes; /* (PL) are there probes for this proc? */ 357 u_int p_dtrace_count; /* (sprlock) number of DTrace tracepoints */ 358 uint8_t p_dtrace_stop; /* indicates a DTrace-desired stop */ 359 user_addr_t p_dtrace_argv; /* (write once, read only after that) */ 360 user_addr_t p_dtrace_envp; /* (write once, read only after that) */ 361 lck_mtx_t p_dtrace_sprlock; /* sun proc lock emulation */ 362 struct dtrace_ptss_page* p_dtrace_ptss_pages; /* (sprlock) list of user ptss pages */ 363 struct dtrace_ptss_page_entry* p_dtrace_ptss_free_list; /* (atomic) list of individual ptss entries */ 364 struct dtrace_helpers* p_dtrace_helpers; /* (dtrace_lock) DTrace per-proc private */ 365 struct dof_ioctl_data* p_dtrace_lazy_dofs; /* (sprlock) unloaded dof_helper_t's */ 366 #endif /* CONFIG_DTRACE */ 367 368 __xnu_struct_group(proc_forkcopy_data, p_forkcopy, { 369 u_int p_argslen; /* Length of process arguments. */ 370 int p_argc; /* saved argc for sysctl_procargs() */ 371 user_addr_t user_stack; /* where user stack was allocated */ 372 struct vnode * XNU_PTRAUTH_SIGNED_PTR("proc.p_textvp") p_textvp; /* Vnode of executable. */ 373 off_t p_textoff; /* offset in executable vnode */ 374 375 sigset_t p_sigmask; /* DEPRECATED */ 376 sigset_t p_sigignore; /* Signals being ignored. (PL) */ 377 sigset_t p_sigcatch; /* Signals being caught by user.(PL) */ 378 379 u_char p_priority; /* (NU) Process priority. */ 380 u_char p_resv0; /* (NU) User-priority based on p_cpu and p_nice. */ 381 char p_nice; /* Process "nice" value.(PL) */ 382 u_char p_resv1; /* (NU) User-priority based on p_cpu and p_nice. */ 383 384 // types currently in sys/param.h 385 command_t p_comm; 386 proc_name_t p_name; /* can be changed by the process */ 387 uint8_t p_xhighbits; /* Stores the top byte of exit status to avoid truncation*/ 388 pid_t p_contproc; /* last PID to send us a SIGCONT (PL) */ 389 390 uint32_t p_pcaction; /* action for process control on starvation */ 391 uint8_t p_uuid[16]; /* from LC_UUID load command */ 392 393 /* 394 * CPU type and subtype of binary slice executed in 395 * this process. Protected by proc lock. 396 */ 397 cpu_type_t p_cputype; 398 cpu_subtype_t p_cpusubtype; 399 }); 400 401 TAILQ_HEAD(, aio_workq_entry ) p_aio_activeq; /* active async IO requests */ 402 TAILQ_HEAD(, aio_workq_entry ) p_aio_doneq; /* completed async IO requests */ 403 404 struct klist p_klist; /* knote list (PL ?)*/ 405 406 struct rusage_superset *p_ru; /* Exit information. (PL) */ 407 thread_t p_signalholder; 408 thread_t p_transholder; 409 int p_sigwaitcnt; 410 /* DEPRECATE following field */ 411 u_short p_acflag; /* Accounting flags. */ 412 volatile u_short p_vfs_iopolicy; /* VFS iopolicy flags. (atomic bit ops) */ 413 414 user_addr_t p_threadstart; /* pthread start fn */ 415 user_addr_t p_wqthread; /* pthread workqueue fn */ 416 int p_pthsize; /* pthread size */ 417 uint32_t p_pth_tsd_offset; /* offset from pthread_t to TSD for new threads */ 418 user_addr_t p_stack_addr_hint; /* stack allocation hint for wq threads */ 419 struct workqueue *_Atomic p_wqptr; /* workq ptr */ 420 421 struct timeval p_start; /* starting time */ 422 void * p_rcall; 423 void * p_pthhash; /* pthread waitqueue hash */ 424 volatile uint64_t was_throttled __attribute__((aligned(8))); /* Counter for number of throttled I/Os */ 425 volatile uint64_t did_throttle __attribute__((aligned(8))); /* Counter for number of I/Os this proc throttled */ 426 427 #if DIAGNOSTIC 428 unsigned int p_fdlock_pc[4]; 429 unsigned int p_fdunlock_pc[4]; 430 #if SIGNAL_DEBUG 431 unsigned int lockpc[8]; 432 unsigned int unlockpc[8]; 433 #endif /* SIGNAL_DEBUG */ 434 #endif /* DIAGNOSTIC */ 435 uint64_t p_dispatchqueue_offset; 436 uint64_t p_dispatchqueue_serialno_offset; 437 uint64_t p_dispatchqueue_label_offset; 438 uint64_t p_return_to_kernel_offset; 439 uint64_t p_mach_thread_self_offset; 440 /* The offset is set to 0 if userspace is not requesting for this feature */ 441 uint64_t p_pthread_wq_quantum_offset; 442 #if VM_PRESSURE_EVENTS 443 struct timeval vm_pressure_last_notify_tstamp; 444 #endif 445 uint8_t p_crash_behavior; /* bit fields to control behavior on crash. See spawn.h POSIX_SPAWN_PANIC* */ 446 bool p_posix_spawn_failed; /* indicates that a posix_spawn failed */ 447 bool p_disallow_map_with_linking; /* used to prevent dyld's map_with_linking() usage after startup */ 448 449 #if CONFIG_MEMORYSTATUS 450 #if CONFIG_FREEZE 451 uint8_t p_memstat_freeze_skip_reason; /* memorystaus_freeze_skipped_reason_t. Protected by the freezer mutex. */ 452 #endif /* CONFIG_FREEZE */ 453 /* Fields protected by proc list lock */ 454 uint32_t p_memstat_state; /* state. Also used as a wakeup channel when the memstat's LOCKED bit changes */ 455 int32_t p_memstat_effectivepriority; /* priority after transaction state accounted for */ 456 int32_t p_memstat_requestedpriority; /* active priority */ 457 int32_t p_memstat_assertionpriority; /* assertion driven priority */ 458 uint32_t p_memstat_dirty; /* dirty state */ 459 TAILQ_ENTRY(proc) p_memstat_list; /* priority bucket link */ 460 uint64_t p_memstat_userdata; /* user state */ 461 uint64_t p_memstat_idledeadline; /* time at which process became clean */ 462 uint64_t p_memstat_idle_start; /* abstime process transitions into the idle band */ 463 uint64_t p_memstat_idle_delta; /* abstime delta spent in idle band */ 464 int32_t p_memstat_memlimit; /* cached memory limit, toggles between active and inactive limits */ 465 int32_t p_memstat_memlimit_active; /* memory limit enforced when process is in active jetsam state */ 466 int32_t p_memstat_memlimit_inactive; /* memory limit enforced when process is in inactive jetsam state */ 467 int32_t p_memstat_relaunch_flags; /* flags indicating relaunch behavior for the process */ 468 #if CONFIG_FREEZE 469 uint32_t p_memstat_freeze_sharedanon_pages; /* shared pages left behind after freeze */ 470 uint32_t p_memstat_frozen_count; 471 uint32_t p_memstat_thaw_count; 472 uint32_t p_memstat_last_thaw_interval; /* In which freezer interval was this last thawed? */ 473 #endif /* CONFIG_FREEZE */ 474 #endif /* CONFIG_MEMORYSTATUS */ 475 476 _Atomic uint32_t p_user_faults; /* count the number of user faults generated */ 477 478 uint32_t p_memlimit_increase; /* byte increase for memory limit for dyld SPI rdar://problem/49950264, structure packing 32-bit and 64-bit */ 479 480 uint64_t p_crash_behavior_deadline; /* mach_continuous_time deadline. After this timestamp p_crash_behavior is invalid */ 481 482 uint32_t p_crash_count; /* Consecutive crash count threshold */ 483 uint32_t p_throttle_timeout; /* Exponential backoff throttle */ 484 485 struct os_reason *p_exit_reason; 486 487 #if CONFIG_PROC_UDATA_STORAGE 488 uint64_t p_user_data; /* general-purpose storage for userland-provided data */ 489 #endif /* CONFIG_PROC_UDATA_STORAGE */ 490 491 char * p_subsystem_root_path; 492 }; 493 494 /* 495 * Identify a process uniquely. 496 * proc_ident's fields match 1-1 with those in struct proc. 497 */ 498 struct proc_ident { 499 uint64_t p_uniqueid; 500 pid_t p_pid; 501 int p_idversion; 502 }; 503 504 #define PGRPID_DEAD 0xdeaddead 505 506 /* p_listflag */ 507 #define P_LIST_WAITING 0x00000010 508 #define P_LIST_CHILDDRSTART 0x00000080 509 #define P_LIST_CHILDDRAINED 0x00000100 510 #define P_LIST_CHILDDRWAIT 0x00000200 511 #define P_LIST_CHILDLKWAIT 0x00000400 512 #define P_LIST_DEADPARENT 0x00000800 513 #define P_LIST_PARENTREFWAIT 0x00001000 514 #define P_LIST_EXITCOUNT 0x00100000 /* counted for process exit */ 515 516 /* local flags */ 517 #define P_LDELAYTERM 0x00000001 /* */ 518 #define P_LHASTASK 0x00000002 /* process points to a task */ 519 #define P_LTERM 0x00000004 /* */ 520 #define P_LEXIT 0x00000008 /* */ 521 #define P_LPEXIT 0x00000010 522 #define P_LTRANSCOMMIT 0x00000020 /* process is committed to trans */ 523 #define P_LINTRANSIT 0x00000040 /* process in exec or in creation */ 524 #define P_LTRANSWAIT 0x00000080 /* waiting for trans to complete */ 525 #define P_LTRACED 0x00000400 /* */ 526 #define P_LSIGEXC 0x00000800 /* */ 527 #define P_LNOATTACH 0x00001000 /* */ 528 #define P_LPPWAIT 0x00002000 /* */ 529 #define P_LPTHREADJITALLOWLIST 0x00004000 /* process has pthread JIT write function allowlist */ 530 #define P_LPTHREADJITFREEZELATE 0x00008000 /* process JIT function allowlist is frozen late */ 531 #define P_LTRACE_WAIT 0x00010000 /* wait for flag to be cleared before starting ptrace */ 532 #define P_LLIMCHANGE 0x00020000 /* process is changing its plimit (rlim_cur, rlim_max) */ 533 #define P_LLIMWAIT 0x00040000 534 #define P_LWAITED 0x00080000 535 #define P_LINSIGNAL 0x00100000 536 #define P_LCUSTOM_STACK 0x00200000 /* process is using custom stack size */ 537 #define P_LRAGE_VNODES 0x00400000 538 #define P_LREGISTER 0x00800000 /* thread start fns registered */ 539 #define P_LVMRSRCOWNER 0x01000000 /* can handle the resource ownership of */ 540 #define P_LTERM_DECRYPTFAIL 0x04000000 /* process terminating due to key failure to decrypt */ 541 #define P_LTERM_JETSAM 0x08000000 /* process is being jetsam'd */ 542 543 #define P_JETSAM_VMPAGESHORTAGE 0x00000000 /* jetsam: lowest jetsam priority proc, killed due to vm page shortage */ 544 #define P_JETSAM_VMTHRASHING 0x10000000 /* jetsam: lowest jetsam priority proc, killed due to vm thrashing */ 545 #define P_JETSAM_HIWAT 0x20000000 /* jetsam: high water mark */ 546 #define P_JETSAM_PID 0x30000000 /* jetsam: pid */ 547 #define P_JETSAM_IDLEEXIT 0x40000000 /* jetsam: idle exit */ 548 #define P_JETSAM_VNODE 0x50000000 /* jetsam: vnode kill */ 549 #define P_JETSAM_FCTHRASHING 0x60000000 /* jetsam: lowest jetsam priority proc, killed due to filecache thrashing */ 550 #define P_JETSAM_MASK 0x70000000 /* jetsam type mask */ 551 #define P_LNSPACE_RESOLVER 0x80000000 /* process is the namespace resolver */ 552 553 /* Process control state for resource starvation */ 554 #define P_PCTHROTTLE 1 555 #define P_PCSUSP 2 556 #define P_PCKILL 3 557 #define P_PCMAX 3 558 559 /* Process control action state on resrouce starvation */ 560 #define PROC_ACTION_MASK 0xffff0000; 561 #define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX) 562 #define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX) 563 #define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16))) 564 #define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p)) 565 566 /* Process exit reason macros */ 567 #define PROC_HAS_EXITREASON(p) (p->p_exit_reason != OS_REASON_NULL) 568 #define PROC_EXITREASON_FLAGS(p) p->p_exit_reason->osr_flags 569 570 /* additional process flags */ 571 #define P_LADVLOCK 0x01 572 #define P_LXBKIDLEINPROG 0x02 573 #define P_RSR 0x04 574 575 /* p_vfs_iopolicy flags */ 576 #define P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY 0x0001 577 #define P_VFS_IOPOLICY_ATIME_UPDATES 0x0002 578 #define P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES 0x0004 579 #define P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME 0x0008 580 #define P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE 0x0010 581 #define P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION 0x0020 582 #define P_VFS_IOPOLICY_IGNORE_NODE_PERMISSIONS 0x0040 583 #define P_VFS_IOPOLICY_SKIP_MTIME_UPDATE 0x0080 584 #define P_VFS_IOPOLICY_ALLOW_LOW_SPACE_WRITES 0x0100 585 #define P_VFS_IOPOLICY_DISALLOW_RW_FOR_O_EVTONLY 0x0200 586 #define P_VFS_IOPOLICY_ALTLINK 0x0400 587 #define P_VFS_IOPOLICY_NOCACHE_WRITE_FS_BLKSIZE 0x0800 588 589 #define P_VFS_IOPOLICY_INHERITED_MASK \ 590 (P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY | \ 591 P_VFS_IOPOLICY_ATIME_UPDATES | \ 592 P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES | \ 593 P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME | \ 594 P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE | \ 595 P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION | \ 596 P_VFS_IOPOLICY_IGNORE_NODE_PERMISSIONS | \ 597 P_VFS_IOPOLICY_SKIP_MTIME_UPDATE | \ 598 P_VFS_IOPOLICY_DISALLOW_RW_FOR_O_EVTONLY | \ 599 P_VFS_IOPOLICY_ALTLINK | \ 600 P_VFS_IOPOLICY_NOCACHE_WRITE_FS_BLKSIZE) 601 602 #define P_VFS_IOPOLICY_VALID_MASK \ 603 (P_VFS_IOPOLICY_INHERITED_MASK | \ 604 P_VFS_IOPOLICY_ALLOW_LOW_SPACE_WRITES) 605 606 /* process creation arguments */ 607 #define PROC_CREATE_FORK 0 /* independent child (running) */ 608 #define PROC_CREATE_SPAWN 1 /* independent child (suspended) */ 609 610 /* LP64 version of extern_proc. all pointers 611 * grow when we're dealing with a 64-bit process. 612 * WARNING - keep in sync with extern_proc 613 * but use native alignment of 64-bit process. 614 */ 615 616 #ifdef KERNEL 617 #include <sys/time.h> /* user_timeval, user_itimerval */ 618 619 /* 620 * This packing is required to ensure symmetry between userspace and kernelspace 621 * when the kernel is 64-bit and the user application is 32-bit. All currently 622 * supported ARM slices (arm64/armv7k/arm64_32) contain the same struct 623 * alignment ABI so this packing isn't needed for ARM. 624 */ 625 #if defined(__x86_64__) 626 #pragma pack(4) 627 #endif 628 struct user32_extern_proc { 629 union { 630 struct { 631 uint32_t __p_forw; /* Doubly-linked run/sleep queue. */ 632 uint32_t __p_back; 633 } p_st1; 634 struct user32_timeval __p_starttime; /* process start time */ 635 } p_un; 636 uint32_t p_vmspace; /* Address space. */ 637 uint32_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 638 int p_flag; /* P_* flags. */ 639 char p_stat; /* S* process status. */ 640 pid_t p_pid; /* Process identifier. */ 641 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 642 int p_dupfd; /* Sideways return value from fdopen. XXX */ 643 /* Mach related */ 644 uint32_t user_stack; /* where user stack was allocated */ 645 uint32_t exit_thread; /* XXX Which thread is exiting? */ 646 int p_debugger; /* allow to debug */ 647 boolean_t sigwait; /* indication to suspend */ 648 /* scheduling */ 649 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 650 int p_cpticks; /* Ticks of cpu time. */ 651 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 652 uint32_t p_wchan; /* Sleep address. */ 653 uint32_t p_wmesg; /* Reason for sleep. */ 654 u_int p_swtime; /* Time swapped in or out. */ 655 u_int p_slptime; /* Time since last blocked. */ 656 struct user32_itimerval p_realtimer; /* Alarm timer. */ 657 struct user32_timeval p_rtime; /* Real time. */ 658 u_quad_t p_uticks; /* Statclock hits in user mode. */ 659 u_quad_t p_sticks; /* Statclock hits in system mode. */ 660 u_quad_t p_iticks; /* Statclock hits processing intr. */ 661 int p_traceflag; /* Kernel trace points. */ 662 uint32_t p_tracep; /* Trace to vnode. */ 663 int p_siglist; /* DEPRECATED */ 664 uint32_t p_textvp; /* Vnode of executable. */ 665 int p_holdcnt; /* If non-zero, don't swap. */ 666 sigset_t p_sigmask; /* DEPRECATED. */ 667 sigset_t p_sigignore; /* Signals being ignored. */ 668 sigset_t p_sigcatch; /* Signals being caught by user. */ 669 u_char p_priority; /* Process priority. */ 670 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 671 char p_nice; /* Process "nice" value. */ 672 char p_comm[MAXCOMLEN + 1]; 673 uint32_t p_pgrp; /* Pointer to process group. */ 674 uint32_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 675 u_short p_xstat; /* Exit status for wait; also stop signal. */ 676 u_short p_acflag; /* Accounting flags. */ 677 uint32_t p_ru; /* Exit information. XXX */ 678 }; 679 #pragma pack() 680 struct user64_extern_proc { 681 union { 682 struct { 683 user_addr_t __p_forw; /* Doubly-linked run/sleep queue. */ 684 user_addr_t __p_back; 685 } p_st1; 686 struct user64_timeval __p_starttime; /* process start time */ 687 } p_un; 688 user_addr_t p_vmspace; /* Address space. */ 689 user_addr_t p_sigacts; /* Signal actions, state (PROC ONLY). */ 690 int p_flag; /* P_* flags. */ 691 char p_stat; /* S* process status. */ 692 pid_t p_pid; /* Process identifier. */ 693 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 694 int p_dupfd; /* Sideways return value from fdopen. XXX */ 695 /* Mach related */ 696 user_addr_t user_stack __attribute((aligned(8))); /* where user stack was allocated */ 697 user_addr_t exit_thread; /* XXX Which thread is exiting? */ 698 int p_debugger; /* allow to debug */ 699 boolean_t sigwait; /* indication to suspend */ 700 /* scheduling */ 701 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 702 int p_cpticks; /* Ticks of cpu time. */ 703 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 704 user_addr_t p_wchan __attribute((aligned(8))); /* Sleep address. */ 705 user_addr_t p_wmesg; /* Reason for sleep. */ 706 u_int p_swtime; /* Time swapped in or out. */ 707 u_int p_slptime; /* Time since last blocked. */ 708 struct user64_itimerval p_realtimer; /* Alarm timer. */ 709 struct user64_timeval p_rtime; /* Real time. */ 710 u_quad_t p_uticks; /* Statclock hits in user mode. */ 711 u_quad_t p_sticks; /* Statclock hits in system mode. */ 712 u_quad_t p_iticks; /* Statclock hits processing intr. */ 713 int p_traceflag; /* Kernel trace points. */ 714 user_addr_t p_tracep __attribute((aligned(8))); /* Trace to vnode. */ 715 int p_siglist; /* DEPRECATED */ 716 user_addr_t p_textvp __attribute((aligned(8))); /* Vnode of executable. */ 717 int p_holdcnt; /* If non-zero, don't swap. */ 718 sigset_t p_sigmask; /* DEPRECATED. */ 719 sigset_t p_sigignore; /* Signals being ignored. */ 720 sigset_t p_sigcatch; /* Signals being caught by user. */ 721 u_char p_priority; /* Process priority. */ 722 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */ 723 char p_nice; /* Process "nice" value. */ 724 char p_comm[MAXCOMLEN + 1]; 725 user_addr_t p_pgrp __attribute((aligned(8))); /* Pointer to process group. */ 726 user_addr_t p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */ 727 u_short p_xstat; /* Exit status for wait; also stop signal. */ 728 u_short p_acflag; /* Accounting flags. */ 729 user_addr_t p_ru __attribute((aligned(8))); /* Exit information. XXX */ 730 }; 731 #endif /* KERNEL */ 732 733 #pragma GCC visibility push(hidden) 734 735 extern struct vfs_context vfs_context0; 736 737 /* 738 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 739 * as it is used to represent "no process group". 740 */ 741 extern int nprocs, maxproc; /* Current and max number of procs. */ 742 extern int maxprocperuid; /* Current number of procs per uid */ 743 extern int hard_maxproc; /* hard limit */ 744 extern unsigned int proc_shutdown_exitcount; 745 746 #define PID_MAX 99999 747 #define NO_PID 100000 748 extern lck_mtx_t proc_list_mlock; 749 750 #define BSD_SIMUL_EXECS 33 /* 32 , allow for rounding */ 751 #define BSD_PAGEABLE_SIZE_PER_EXEC (NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */ 752 extern int execargs_cache_size; 753 extern int execargs_free_count; 754 extern vm_offset_t * execargs_cache; 755 756 #define SESS_LEADER(p, sessp) ((sessp)->s_leader == (p)) 757 758 #define SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash]) 759 extern LIST_HEAD(sesshashhead, session) * sesshashtbl; 760 extern u_long sesshash; 761 762 extern lck_attr_t proc_lck_attr; 763 extern lck_grp_t proc_fdmlock_grp; 764 extern lck_grp_t proc_lck_grp; 765 extern lck_grp_t proc_kqhashlock_grp; 766 extern lck_grp_t proc_knhashlock_grp; 767 extern lck_grp_t proc_slock_grp; 768 extern lck_grp_t proc_mlock_grp; 769 extern lck_grp_t proc_ucred_mlock_grp; 770 extern lck_grp_t proc_dirslock_grp; 771 772 LIST_HEAD(proclist, proc); 773 extern struct proclist allproc; /* List of all processes. */ 774 extern struct proclist zombproc; /* List of zombie processes. */ 775 776 #if CONFIG_COREDUMP 777 extern const char * defaultcorefiledir; 778 extern const char * defaultdrivercorefiledir; 779 extern char corefilename[MAXPATHLEN + 1]; 780 extern char drivercorefilename[MAXPATHLEN + 1]; 781 extern int do_coredump; 782 extern int sugid_coredump; 783 #endif 784 785 __options_decl(cloneproc_flags_t, uint32_t, { 786 CLONEPROC_FLAGS_NONE = 0, 787 CLONEPROC_FLAGS_INHERIT_MEMORY = 0x0001, 788 CLONEPROC_FLAGS_MEMSTAT_INTERNAL = 0x0002, 789 CLONEPROC_FLAGS_FOR_EXEC = 0x0004, 790 }); 791 792 extern thread_t cloneproc(task_t, coalition_t *, proc_t, cloneproc_flags_t); 793 extern struct proc * XNU_PTRAUTH_SIGNED_PTR("initproc") initproc; 794 extern void proc_lock(struct proc *); 795 extern void proc_unlock(struct proc *); 796 extern void proc_spinlock(struct proc *); 797 extern void proc_spinunlock(struct proc *); 798 extern void proc_list_lock(void); 799 extern void proc_list_unlock(void); 800 extern void proc_klist_lock(void); 801 extern void proc_klist_unlock(void); 802 extern void proc_fdlock(struct proc *); 803 extern void proc_fdlock_spin(struct proc *); 804 extern void proc_fdunlock(struct proc *); 805 extern void proc_fdlock_assert(proc_t p, int assertflags); 806 extern void proc_dirs_lock_shared(struct proc *); 807 extern void proc_dirs_unlock_shared(struct proc *); 808 extern void proc_dirs_lock_exclusive(struct proc *); 809 extern void proc_dirs_unlock_exclusive(struct proc *); 810 extern void proc_ucred_lock(struct proc *); 811 extern void proc_ucred_unlock(struct proc *); 812 extern void proc_update_creds_onproc(struct proc *, kauth_cred_t cred); 813 extern kauth_cred_t proc_ucred_locked(proc_t p); 814 extern kauth_cred_t proc_ucred_smr(proc_t p); 815 extern kauth_cred_t proc_ucred_unsafe(proc_t p) __exported; 816 #if CONFIG_COREDUMP 817 __private_extern__ int proc_core_name(const char *format, const char *name, uid_t uid, pid_t pid, 818 char *cr_name, size_t cr_name_len); 819 #endif 820 extern int isinferior(struct proc *, struct proc *); 821 __private_extern__ struct proc *pzfind(pid_t); /* Find zombie by id. */ 822 __private_extern__ struct proc *proc_find_zombref(pid_t); /* Find zombie by id. */ 823 __private_extern__ void proc_drop_zombref(struct proc * p); /* Find zombie by id. */ 824 825 extern size_t chgproccnt(uid_t uid, int diff); 826 extern void pinsertchild(struct proc *parent, struct proc *child, bool in_exec); 827 extern void p_reparentallchildren(proc_t old_proc, proc_t new_proc); 828 extern int setsid_internal(struct proc *p); 829 #ifndef __cplusplus 830 extern void setlogin_internal(proc_t p, const char login[static MAXLOGNAME]); 831 #endif // __cplusplus 832 extern int setgroups_internal(proc_t p, u_int gidsetsize, gid_t *gidset, uid_t gmuid); 833 extern int enterpgrp(struct proc *p, pid_t pgid, int mksess); 834 extern void fixjobc(struct proc *p, struct pgrp *pgrp, int entering); 835 extern int inferior(struct proc *p); 836 extern void resetpriority(struct proc *); 837 extern void setrunnable(struct proc *); 838 extern void setrunqueue(struct proc *); 839 extern int sleep(void *chan, int pri) __exported; 840 extern int tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int)); 841 extern int tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int)); 842 extern int exit1(struct proc *, int, int *); 843 extern int exit1_internal(struct proc *, int, int *, boolean_t, boolean_t, int); 844 extern int exit_with_reason(struct proc *, int, int *, boolean_t, boolean_t, int, struct os_reason *); 845 extern int fork1(proc_t, thread_t *, int, coalition_t *); 846 extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked); 847 848 extern bool proc_list_exited(proc_t p); 849 extern proc_t proc_find_locked(int pid); 850 extern bool proc_is_shadow(proc_t p); 851 extern proc_t proc_findthread(thread_t thread); 852 extern void proc_refdrain(proc_t); 853 extern proc_t proc_refdrain_will_exec(proc_t p); 854 extern void proc_refwake_did_exec(proc_t p); 855 extern void proc_childdrainlocked(proc_t); 856 extern void proc_childdrainstart(proc_t); 857 extern void proc_childdrainend(proc_t); 858 extern void proc_checkdeadrefs(proc_t); 859 struct proc *phash_find_locked(pid_t); 860 extern void phash_insert_locked(struct proc *); 861 extern void phash_remove_locked(struct proc *); 862 extern void phash_replace_locked(struct proc *old_proc, struct proc *new_proc); 863 extern bool pghash_exists_locked(pid_t); 864 extern void pghash_insert_locked(struct pgrp *); 865 extern struct pgrp *pgrp_find(pid_t); 866 extern void pgrp_rele(struct pgrp * pgrp); 867 extern struct session * session_find_internal(pid_t sessid); 868 extern struct pgrp *proc_pgrp(proc_t, struct session **); 869 extern struct pgrp *pgrp_leave_locked(struct proc *p); 870 extern struct pgrp *pgrp_enter_locked(struct proc *parent, struct proc *p); 871 extern struct pgrp *tty_pgrp_locked(struct tty * tp); 872 struct pgrp *pgrp_alloc(pid_t pgid, pggrp_ref_bits_t bits); 873 extern void pgrp_lock(struct pgrp * pgrp); 874 extern void pgrp_unlock(struct pgrp * pgrp); 875 extern struct session *session_find_locked(pid_t sessid); 876 extern void session_replace_leader(struct proc *old_proc, struct proc *new_proc); 877 extern struct session *session_alloc(struct proc *leader); 878 extern void session_lock(struct session * sess); 879 extern void session_unlock(struct session * sess); 880 extern struct session *session_ref(struct session *sess); 881 extern void session_rele(struct session *sess); 882 extern struct tty *session_set_tty_locked(struct session *sessp, struct tty *); 883 extern struct tty *session_clear_tty_locked(struct session *sess); 884 extern struct tty *session_tty(struct session *sess); 885 extern proc_t proc_parentholdref(proc_t); 886 extern int proc_parentdropref(proc_t, int); 887 int itimerfix(struct timeval *tv); 888 int itimerdecr(struct proc * p, struct itimerval *itp, int usec); 889 void proc_free_realitimer(proc_t proc); 890 void proc_inherit_itimers(struct proc *old_proc, struct proc *new_proc); 891 int timespec_is_valid(const struct timespec *); 892 void proc_signalstart(struct proc *, int locked); 893 void proc_signalend(struct proc *, int locked); 894 int proc_transstart(struct proc *, int locked, int non_blocking); 895 void proc_transcommit(struct proc *, int locked); 896 void proc_transend(struct proc *, int locked); 897 int proc_transwait(struct proc *, int locked); 898 struct proc *proc_ref(struct proc *p, int locked); 899 void proc_wait_release(struct proc *p); 900 void proc_knote(struct proc * p, long hint); 901 void proc_transfer_knotes(struct proc *old_proc, struct proc *new_proc); 902 void proc_knote_drain(struct proc *p); 903 void proc_setregister(proc_t p); 904 void proc_resetregister(proc_t p); 905 bool proc_get_pthread_jit_allowlist(proc_t p, bool *late_out); 906 void proc_set_pthread_jit_allowlist(proc_t p, bool late); 907 /* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */ 908 thread_t proc_thread(proc_t); 909 extern int proc_pendingsignals(proc_t, sigset_t); 910 int proc_getpcontrol(int pid, int * pcontrolp); 911 int proc_dopcontrol(proc_t p); 912 int proc_resetpcontrol(int pid); 913 #if PSYNCH 914 void pth_proc_hashinit(proc_t); 915 void pth_proc_hashdelete(proc_t); 916 void pth_global_hashinit(void); 917 extern thread_call_t psynch_thcall; 918 void psynch_wq_cleanup(__unused void * param, __unused void * param1); 919 extern lck_mtx_t * pthread_list_mlock; 920 #endif /* PSYNCH */ 921 struct uthread *current_uthread(void) __pure2; 922 923 extern void proc_set_task(proc_t, task_t); 924 extern task_t proc_get_task_raw(proc_t proc); 925 extern proc_t task_get_proc_raw(task_t task); 926 extern void proc_ref_hold_proc_task_struct(proc_t proc); 927 extern void proc_release_proc_task_struct(proc_t proc); 928 extern void task_ref_hold_proc_task_struct(task_t task); 929 extern void task_release_proc_task_struct(task_t task); 930 extern void proc_setpidversion(proc_t, int); 931 extern uint64_t proc_getcsflags(proc_t); 932 extern void proc_csflags_update(proc_t, uint64_t); 933 extern void proc_csflags_set(proc_t, uint64_t); 934 extern void proc_csflags_clear(proc_t, uint64_t); 935 extern uint8_t *proc_syscall_filter_mask(proc_t); 936 extern void proc_syscall_filter_mask_set(proc_t, uint8_t *); 937 extern pid_t proc_getpid(proc_t); 938 extern void proc_setplatformdata(proc_t, uint32_t, uint32_t, uint32_t); 939 extern void proc_set_sigact(proc_t, int, user_addr_t); 940 extern void proc_set_trampact(proc_t, int, user_addr_t); 941 extern void proc_set_sigact_trampact(proc_t, int, user_addr_t, user_addr_t); 942 extern void proc_reset_sigact(proc_t, sigset_t); 943 extern void proc_setexecutableuuid(proc_t, const uuid_t); 944 extern const unsigned char *proc_executableuuid_addr(proc_t); 945 946 947 #pragma mark - process iteration 948 949 /* 950 * ALLPROC_FOREACH cannot be used to access the task, as the field may be 951 * swapped out during exec. With `proc_iterate`, find threads by iterating the 952 * `p_uthlist` field of the proc, under the `proc_lock`. 953 */ 954 955 #define ALLPROC_FOREACH(var) \ 956 LIST_FOREACH((var), &allproc, p_list) 957 958 #define ZOMBPROC_FOREACH(var) \ 959 LIST_FOREACH((var), &zombproc, p_list) 960 961 #define PGMEMBERS_FOREACH(group, var) \ 962 LIST_FOREACH((var), &((struct pgrp *)(group))->pg_members, p_pglist) 963 964 #define PCHILDREN_FOREACH(parent, var) \ 965 LIST_FOREACH((var), &(((struct proc *)(parent))->p_children), p_sibling) 966 967 typedef int (*proc_iterate_fn_t)(proc_t, void *); 968 969 /* 970 * These are the only valid return values of `callout` functions provided to 971 * process iterators. 972 * 973 * CLAIMED returns expect the caller to call proc_rele on the proc. DONE 974 * returns stop iterating processes early. 975 */ 976 #define PROC_RETURNED (0) 977 #define PROC_RETURNED_DONE (1) 978 #define PROC_CLAIMED (2) 979 #define PROC_CLAIMED_DONE (3) 980 981 /* 982 * pgrp_iterate walks the provided process group, calling `filterfn` with 983 * `filterarg` for each process. For processes where `filterfn` returned 984 * non-zero, `callout` is called with `arg`. 985 * 986 * `PGMEMBERS_FOREACH` might also be used under the pgrp_lock to achieve a 987 * similar effect. 988 */ 989 990 extern void pgrp_iterate(struct pgrp *pgrp, proc_iterate_fn_t callout, 991 void *arg, bool (^filterfn)(proc_t)); 992 993 /* 994 * proc_iterate walks the `allproc` and/or `zombproc` lists, calling `filterfn` 995 * with `filterarg` for each process. For processes where `filterfn` returned 996 * non-zero, `callout` is called with `arg`. If the `PROC_NOWAITTRANS` flag is 997 * unset, this function waits for transitions. 998 * 999 * `ALLPROC_FOREACH` or `ZOMBPROC_FOREACH` might also be used under the 1000 * `proc_list_lock` to achieve a similar effect. 1001 */ 1002 #define PROC_ALLPROCLIST (1U << 0) /* walk the allproc list (processes not yet exited) */ 1003 #define PROC_ZOMBPROCLIST (1U << 1) /* walk the zombie list */ 1004 #define PROC_NOWAITTRANS (1U << 2) /* do not wait for transitions (checkdirs only) */ 1005 1006 extern void proc_iterate(unsigned int flags, proc_iterate_fn_t callout, 1007 void *arg, proc_iterate_fn_t filterfn, void *filterarg); 1008 1009 /* 1010 * proc_childrenwalk walks the children of process `p`, calling `callout` for 1011 * each one. 1012 * 1013 * `PCHILDREN_FOREACH` might also be used under the `proc_list_lock` to achieve 1014 * a similar effect. 1015 */ 1016 extern void proc_childrenwalk(proc_t p, proc_iterate_fn_t callout, void *arg); 1017 1018 /* 1019 * proc_rebootscan should only be used by kern_shutdown.c 1020 */ 1021 extern void proc_rebootscan(proc_iterate_fn_t callout, void *arg, 1022 proc_iterate_fn_t filterfn, void *filterarg); 1023 1024 pid_t dtrace_proc_selfpid(void); 1025 pid_t dtrace_proc_selfppid(void); 1026 uid_t dtrace_proc_selfruid(void); 1027 1028 os_refgrp_decl_extern(p_refgrp); 1029 KALLOC_TYPE_DECLARE(proc_stats_zone); 1030 ZONE_DECLARE_ID(ZONE_ID_PROC_TASK, struct proc); 1031 extern zone_t proc_task_zone; 1032 1033 extern struct proc_ident proc_ident(proc_t p); 1034 1035 #if CONFIG_PROC_RESOURCE_LIMITS 1036 int proc_set_filedesc_limits(proc_t p, int soft_limit, int hard_limit); 1037 #endif /* CONFIG_PROC_RESOURCE_LIMITS */ 1038 1039 /* 1040 * True if the process ignores file permissions in case it owns the 1041 * file/directory 1042 */ 1043 bool proc_ignores_node_permissions(proc_t proc); 1044 1045 #pragma GCC visibility pop 1046 #endif /* !_SYS_PROC_INTERNAL_H_ */ 1047