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