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