bsd/sys/proc_internal.h

   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 <libkern/OSAtomic.h>
  79 #include <sys/proc.h>
  80 #include <mach/resource_monitors.h>     // command/proc_name_t
  81
  82 __BEGIN_DECLS
  83 #include <kern/locks.h>
  84 #if PSYNCH
  85 #include <kern/thread_call.h>
  86 #endif /* PSYNCH */
  87 __END_DECLS
  88
  89 #if DEBUG
  90 #define __PROC_INTERNAL_DEBUG 1
  91 #endif
  92
  93 /*
  94  * The short form for various locks that protect fields in the data structures.
  95  * PL = Process Lock
  96  * PGL = Process Group Lock
  97  * PFDL = Process File Desc Lock
  98  * PUCL = Process User Credentials Lock
  99  * PSL = Process Spin Lock
 100  * LL = List Lock
 101  * SL = Session Lock
 102  */
 103 struct label;
 104
 105 /*
 106  * One structure allocated per session.
 107  */
 108 struct  session {
 109         int                     s_count;                /* Ref cnt; pgrps in session. (LL) */
 110         struct  proc *          s_leader;               /* Session leader.(static) */
 111         struct  vnode *         s_ttyvp;                /* Vnode of controlling terminal.(SL) */
 112         int                     s_ttyvid;               /* Vnode id of the controlling terminal (SL) */
 113         struct  tty *           s_ttyp;                 /* Controlling terminal. (SL + ttyvp != NULL) */
 114         pid_t                   s_ttypgrpid;            /* tty's pgrp id */
 115         pid_t                   s_sid;                  /* Session ID (static) */
 116         char                    s_login[MAXLOGNAME];    /* Setlogin() name.(SL) */
 117         int                     s_flags;                /* Session flags (s_mlock)  */
 118         LIST_ENTRY(session)     s_hash;                 /* Hash chain.(LL) */
 119         lck_mtx_t               s_mlock;                /* mutex lock to protect session */
 120         int                     s_listflags;
 121 };
 122
 123 #define SESSION_NULL (struct session *)NULL
 124
 125 /*
 126  * accessor for s_ttyp which treats it as invalid if s_ttyvp is not valid;
 127  * note that s_ttyp is not a reference in the session structre, so it can
 128  * become invalid out from under the session if the device is closed, without
 129  * this protection.  We can't safely make it into a reference without reflexive
 130  * close notification of tty devices through cdevsw[].
 131  *
 132  * NB:  <sys/tty.h> is not in scope and there is not typedef type enforcement,
 133  *      or '0' below would be 'TTY_NULL'.
 134  */
 135 #define SESSION_TP(sp)  (((sp)->s_ttyvp != 0) ? (sp)->s_ttyp : 0)
 136
 137 /*
 138  * Session flags; used to tunnel information to lower layers and line
 139  * disciplines, etc.
 140  */
 141 #define S_DEFAULT       0x00000000      /* No flags set */
 142 #define S_NOCTTY        0x00000001      /* Do not associate controlling tty */
 143 #define S_CTTYREF       0x00000010      /* vnode ref taken by cttyopen */
 144
 145
 146 #define S_LIST_TERM     1               /* marked for termination */
 147 #define S_LIST_DEAD     2               /* already dead */
 148 /*
 149  * One structure allocated per process group.
 150  */
 151 struct  pgrp {
 152         LIST_ENTRY(pgrp)        pg_hash;        /* Hash chain. (LL) */
 153         LIST_HEAD(, proc)       pg_members;     /* Pointer to pgrp members. (PGL) */
 154         struct  session *       pg_session;     /* Pointer to session. (LL ) */
 155         pid_t                   pg_id;          /* Pgrp id. (static) */
 156         int                     pg_jobc;        /* # procs qualifying pgrp for job control (PGL) */
 157         int                     pg_membercnt;   /* Number of processes in the pgrocess group (PGL) */
 158         int                     pg_refcount;    /* number of current iterators (LL) */
 159         unsigned int            pg_listflags;   /* (LL) */
 160         lck_mtx_t               pg_mlock;       /* mutex lock to protect pgrp */
 161 };
 162
 163 #define PGRP_FLAG_TERMINATE     1
 164 #define PGRP_FLAG_WAITTERMINATE 2
 165 #define PGRP_FLAG_DEAD          4
 166 #define PGRP_FLAG_ITERABEGIN    8
 167 #define PGRP_FLAG_ITERWAIT      0x10
 168
 169 #define PGRP_NULL (struct pgrp *)NULL
 170 struct proc;
 171
 172 #define PROC_NULL (struct proc *)NULL
 173
 174 #define PROC_UPDATE_CREDS_ONPROC(p) { \
 175         p->p_uid =  kauth_cred_getuid(p->p_ucred); \
 176         p->p_gid =  kauth_cred_getgid(p->p_ucred); \
 177         p->p_ruid =  kauth_cred_getruid(p->p_ucred); \
 178         p->p_rgid =  kauth_cred_getrgid(p->p_ucred); \
 179         p->p_svuid =  kauth_cred_getsvuid(p->p_ucred); \
 180         p->p_svgid =  kauth_cred_getsvgid(p->p_ucred); \
 181         }
 182 /*
 183  * Description of a process.
 184  *
 185  * This structure contains the information needed to manage a thread of
 186  * control, known in UN*X as a process; it has references to substructures
 187  * containing descriptions of things that the process uses, but may share
 188  * with related processes.  The process structure and the substructures
 189  * are always addressible except for those marked "(PROC ONLY)" below,
 190  * which might be addressible only on a processor on which the process
 191  * is running.
 192  */
 193 struct  proc {
 194         LIST_ENTRY(proc) p_list;                /* List of all processes. */
 195
 196         void *          XNU_PTRAUTH_SIGNED_PTR("proc.task") task;       /* corresponding task (static)*/
 197         struct  proc *  XNU_PTRAUTH_SIGNED_PTR("proc.p_pptr") p_pptr;   /* Pointer to parent process.(LL) */
 198         pid_t           p_ppid;                 /* process's parent pid number */
 199         pid_t           p_original_ppid;        /* process's original parent pid number, doesn't change if reparented */
 200         pid_t           p_pgrpid;               /* process group id of the process (LL)*/
 201         uid_t           p_uid;
 202         gid_t           p_gid;
 203         uid_t           p_ruid;
 204         gid_t           p_rgid;
 205         uid_t           p_svuid;
 206         gid_t           p_svgid;
 207         uint64_t        p_uniqueid;             /* process unique ID - incremented on fork/spawn/vfork, remains same across exec. */
 208         uint64_t        p_puniqueid;            /* parent's unique ID - set on fork/spawn/vfork, doesn't change if reparented. */
 209
 210         lck_mtx_t       p_mlock;                /* mutex lock for proc */
 211         pid_t           p_pid;                  /* Process identifier. (static)*/
 212         char            p_stat;                 /* S* process status. (PL)*/
 213         char            p_shutdownstate;
 214         char            p_kdebug;               /* P_KDEBUG eq (CC)*/
 215         char            p_btrace;               /* P_BTRACE eq (CC)*/
 216
 217         LIST_ENTRY(proc) p_pglist;              /* List of processes in pgrp.(PGL) */
 218         LIST_ENTRY(proc) p_sibling;             /* List of sibling processes. (LL)*/
 219         LIST_HEAD(, proc) p_children;           /* Pointer to list of children. (LL)*/
 220         TAILQ_HEAD(, uthread) p_uthlist;        /* List of uthreads  (PL) */
 221
 222         LIST_ENTRY(proc) p_hash;                /* Hash chain. (LL)*/
 223
 224 #if CONFIG_PERSONAS
 225         struct persona  *p_persona;
 226         LIST_ENTRY(proc) p_persona_list;
 227 #endif
 228
 229         lck_mtx_t       p_fdmlock;              /* proc lock to protect fdesc */
 230         lck_mtx_t       p_ucred_mlock;          /* mutex lock to protect p_ucred */
 231
 232         /* substructures: */
 233         kauth_cred_t    XNU_PTRAUTH_SIGNED_PTR("proc.p_ucred") p_ucred; /* Process owner's identity. (PUCL) */
 234         struct  filedesc *p_fd;                 /* Ptr to open files structure. (PFDL) */
 235         struct  pstats *p_stats;                /* Accounting/statistics (PL). */
 236         struct  plimit *p_limit;                /* Process limits.(PL) */
 237
 238         struct  sigacts *p_sigacts;             /* Signal actions, state (PL) */
 239         lck_spin_t      p_slock;                /* spin lock for itimer/profil protection */
 240
 241         int             p_siglist;              /* signals captured back from threads */
 242         unsigned int    p_flag;                 /* P_* flags. (atomic bit ops) */
 243         unsigned int    p_lflag;                /* local flags  (PL) */
 244         unsigned int    p_listflag;             /* list flags (LL) */
 245         unsigned int    p_ladvflag;             /* local adv flags (atomic) */
 246         int             p_refcount;             /* number of outstanding users(LL) */
 247         int             p_childrencnt;          /* children holding ref on parent (LL) */
 248         int             p_parentref;            /* children lookup ref on parent (LL) */
 249         pid_t           p_oppid;                /* Save parent pid during ptrace. XXX */
 250         u_int           p_xstat;                /* Exit status for wait; also stop signal. */
 251
 252 #ifdef _PROC_HAS_SCHEDINFO_
 253         /* may need cleanup, not used */
 254         u_int           p_estcpu;               /* Time averaged value of p_cpticks.(used by aio and proc_comapre) */
 255         fixpt_t         p_pctcpu;               /* %cpu for this process during p_swtime (used by aio)*/
 256         u_int           p_slptime;              /* used by proc_compare */
 257 #endif /* _PROC_HAS_SCHEDINFO_ */
 258
 259         struct  itimerval p_realtimer;          /* Alarm timer. (PSL) */
 260         struct  timeval p_rtime;                /* Real time.(PSL)  */
 261         struct  itimerval p_vtimer_user;        /* Virtual timers.(PSL)  */
 262         struct  itimerval p_vtimer_prof;        /* (PSL) */
 263
 264         struct  timeval p_rlim_cpu;             /* Remaining rlim cpu value.(PSL) */
 265         int             p_debugger;             /*  NU 1: can exec set-bit programs if suser */
 266         boolean_t       sigwait;        /* indication to suspend (PL) */
 267         void    *sigwait_thread;        /* 'thread' holding sigwait(PL)  */
 268         void    *exit_thread;           /* Which thread is exiting(PL)  */
 269         void *  p_vforkact;             /* activation running this vfork proc)(static)  */
 270         int     p_vforkcnt;             /* number of outstanding vforks(PL)  */
 271         int     p_fpdrainwait;          /* (PFDL) */
 272         /* Following fields are info from SIGCHLD (PL) */
 273         pid_t   si_pid;                 /* (PL) */
 274         u_int   si_status;              /* (PL) */
 275         u_int   si_code;                /* (PL) */
 276         uid_t   si_uid;                 /* (PL) */
 277
 278         void * vm_shm;                  /* (SYSV SHM Lock) for sysV shared memory */
 279
 280 #if CONFIG_DTRACE
 281         user_addr_t                     p_dtrace_argv;                  /* (write once, read only after that) */
 282         user_addr_t                     p_dtrace_envp;                  /* (write once, read only after that) */
 283         lck_mtx_t                       p_dtrace_sprlock;               /* sun proc lock emulation */
 284         uint8_t                         p_dtrace_stop;                  /* indicates a DTrace-desired stop */
 285         int                             p_dtrace_probes;                /* (PL) are there probes for this proc? */
 286         u_int                           p_dtrace_count;                 /* (sprlock) number of DTrace tracepoints */
 287         struct dtrace_ptss_page*        p_dtrace_ptss_pages;            /* (sprlock) list of user ptss pages */
 288         struct dtrace_ptss_page_entry*  p_dtrace_ptss_free_list;        /* (atomic) list of individual ptss entries */
 289         struct dtrace_helpers*          p_dtrace_helpers;               /* (dtrace_lock) DTrace per-proc private */
 290         struct dof_ioctl_data*          p_dtrace_lazy_dofs;             /* (sprlock) unloaded dof_helper_t's */
 291 #endif /* CONFIG_DTRACE */
 292
 293 /* XXXXXXXXXXXXX BCOPY'ed on fork XXXXXXXXXXXXXXXX */
 294 /* The following fields are all copied upon creation in fork. */
 295 #define p_startcopy     p_argslen
 296
 297         u_int   p_argslen;       /* Length of process arguments. */
 298         int     p_argc;                 /* saved argc for sysctl_procargs() */
 299         user_addr_t user_stack;         /* where user stack was allocated */
 300         struct  vnode * XNU_PTRAUTH_SIGNED_PTR("proc.p_textvp") p_textvp;       /* Vnode of executable. */
 301         off_t   p_textoff;              /* offset in executable vnode */
 302
 303         sigset_t p_sigmask;             /* DEPRECATED */
 304         sigset_t p_sigignore;   /* Signals being ignored. (PL) */
 305         sigset_t p_sigcatch;    /* Signals being caught by user.(PL)  */
 306
 307         u_char  p_priority;     /* (NU) Process priority. */
 308         u_char  p_resv0;        /* (NU) User-priority based on p_cpu and p_nice. */
 309         char    p_nice;         /* Process "nice" value.(PL) */
 310         u_char  p_resv1;        /* (NU) User-priority based on p_cpu and p_nice. */
 311
 312         // types currently in sys/param.h
 313         command_t   p_comm;
 314         proc_name_t p_name;     /* can be changed by the process */
 315         uint8_t p_xhighbits;    /* Stores the top byte of exit status to avoid truncation*/
 316         pid_t   p_contproc;     /* last PID to send us a SIGCONT (PL) */
 317
 318         struct  pgrp *  XNU_PTRAUTH_SIGNED_PTR("proc.p_pgrp") p_pgrp; /* Pointer to process group. (LL) */
 319         uint32_t        p_csflags;      /* flags for codesign (PL) */
 320         uint32_t        p_pcaction;     /* action  for process control on starvation */
 321         uint8_t p_uuid[16];             /* from LC_UUID load command */
 322
 323         /*
 324          * CPU type and subtype of binary slice executed in
 325          * this process.  Protected by proc lock.
 326          */
 327         cpu_type_t      p_cputype;
 328         cpu_subtype_t   p_cpusubtype;
 329
 330         uint8_t  *syscall_filter_mask;          /* syscall filter bitmask (length: nsysent bits) */
 331         uint32_t        p_platform;
 332         uint32_t        p_min_sdk;
 333         uint32_t        p_sdk;
 334
 335 /* End area that is copied on creation. */
 336 /* XXXXXXXXXXXXX End of BCOPY'ed on fork (AIOLOCK)XXXXXXXXXXXXXXXX */
 337 #define p_endcopy       p_aio_total_count
 338         int             p_aio_total_count;              /* all allocated AIO requests for this proc */
 339         TAILQ_HEAD(, aio_workq_entry ) p_aio_activeq;   /* active async IO requests */
 340         TAILQ_HEAD(, aio_workq_entry ) p_aio_doneq;     /* completed async IO requests */
 341
 342         struct klist p_klist;  /* knote list (PL ?)*/
 343
 344         struct  rusage_superset *p_ru;  /* Exit information. (PL) */
 345         thread_t        p_signalholder;
 346         thread_t        p_transholder;
 347         int             p_sigwaitcnt;
 348         /* DEPRECATE following field  */
 349         u_short p_acflag;       /* Accounting flags. */
 350         volatile u_short p_vfs_iopolicy;        /* VFS iopolicy flags. (atomic bit ops) */
 351
 352         user_addr_t     p_threadstart;          /* pthread start fn */
 353         user_addr_t     p_wqthread;             /* pthread workqueue fn */
 354         int     p_pthsize;                      /* pthread size */
 355         uint32_t        p_pth_tsd_offset;       /* offset from pthread_t to TSD for new threads */
 356         user_addr_t     p_stack_addr_hint;      /* stack allocation hint for wq threads */
 357         struct workqueue *_Atomic p_wqptr;                      /* workq ptr */
 358
 359         struct  timeval p_start;                /* starting time */
 360         void *  p_rcall;
 361         int             p_ractive;
 362         int     p_idversion;            /* version of process identity */
 363         void *  p_pthhash;                      /* pthread waitqueue hash */
 364         volatile uint64_t was_throttled __attribute__((aligned(8))); /* Counter for number of throttled I/Os */
 365         volatile uint64_t did_throttle __attribute__((aligned(8)));  /* Counter for number of I/Os this proc throttled */
 366
 367 #if DIAGNOSTIC
 368         unsigned int p_fdlock_pc[4];
 369         unsigned int p_fdunlock_pc[4];
 370 #if SIGNAL_DEBUG
 371         unsigned int lockpc[8];
 372         unsigned int unlockpc[8];
 373 #endif /* SIGNAL_DEBUG */
 374 #endif /* DIAGNOSTIC */
 375         uint64_t        p_dispatchqueue_offset;
 376         uint64_t        p_dispatchqueue_serialno_offset;
 377         uint64_t        p_dispatchqueue_label_offset;
 378         uint64_t        p_return_to_kernel_offset;
 379         uint64_t        p_mach_thread_self_offset;
 380 #if VM_PRESSURE_EVENTS
 381         struct timeval  vm_pressure_last_notify_tstamp;
 382 #endif
 383
 384 #if CONFIG_MEMORYSTATUS
 385         /* Fields protected by proc list lock */
 386         TAILQ_ENTRY(proc) p_memstat_list;               /* priority bucket link */
 387         uint32_t          p_memstat_state;              /* state. Also used as a wakeup channel when the memstat's LOCKED bit changes */
 388         int32_t           p_memstat_effectivepriority;  /* priority after transaction state accounted for */
 389         int32_t           p_memstat_requestedpriority;  /* active priority */
 390         int32_t           p_memstat_assertionpriority;  /* assertion driven priority */
 391         uint32_t          p_memstat_dirty;              /* dirty state */
 392         uint64_t          p_memstat_userdata;           /* user state */
 393         uint64_t          p_memstat_idledeadline;       /* time at which process became clean */
 394         uint64_t          p_memstat_idle_start;         /* abstime process transitions into the idle band */
 395         uint64_t          p_memstat_idle_delta;         /* abstime delta spent in idle band */
 396         int32_t           p_memstat_memlimit;           /* cached memory limit, toggles between active and inactive limits */
 397         int32_t           p_memstat_memlimit_active;    /* memory limit enforced when process is in active jetsam state */
 398         int32_t           p_memstat_memlimit_inactive;  /* memory limit enforced when process is in inactive jetsam state */
 399         int32_t           p_memstat_relaunch_flags;     /* flags indicating relaunch behavior for the process */
 400 #if CONFIG_FREEZE
 401         uint32_t          p_memstat_freeze_sharedanon_pages; /* shared pages left behind after freeze */
 402         uint32_t          p_memstat_frozen_count;
 403         uint32_t          p_memstat_thaw_count;
 404 #endif /* CONFIG_FREEZE */
 405 #endif /* CONFIG_MEMORYSTATUS */
 406
 407         /* cached proc-specific data required for corpse inspection */
 408         pid_t             p_responsible_pid;    /* pid resonsible for this process */
 409         _Atomic uint32_t  p_user_faults; /* count the number of user faults generated */
 410
 411         uint32_t          p_memlimit_increase; /* byte increase for memory limit for dyld SPI rdar://problem/49950264, structure packing 32-bit and 64-bit */
 412
 413         struct os_reason     *p_exit_reason;
 414
 415 #if CONFIG_PROC_UDATA_STORAGE
 416         uint64_t        p_user_data;                    /* general-purpose storage for userland-provided data */
 417 #endif /* CONFIG_PROC_UDATA_STORAGE */
 418
 419         char * p_subsystem_root_path;
 420         lck_rw_t        p_dirs_lock;                    /* keeps fd_cdir and fd_rdir stable across a lookup */
 421         pid_t           p_sessionid;
 422 };
 423
 424 /*
 425  * Identify a process uniquely.
 426  * proc_ident's fields match 1-1 with those in struct proc.
 427  */
 428 struct proc_ident {
 429         uint64_t        p_uniqueid;
 430         pid_t           p_pid;
 431         int             p_idversion;
 432 };
 433
 434 #define PGRPID_DEAD 0xdeaddead
 435
 436 /* p_listflag */
 437 #define P_LIST_DRAIN                    0x00000001
 438 #define P_LIST_DRAINWAIT                0x00000002
 439 #define P_LIST_DRAINED                  0x00000004
 440 #define P_LIST_DEAD                             0x00000008
 441 #define P_LIST_WAITING                  0x00000010
 442 #define P_LIST_EXITED                   0x00000040
 443 #define P_LIST_CHILDDRSTART     0x00000080
 444 #define P_LIST_CHILDDRAINED     0x00000100
 445 #define P_LIST_CHILDDRWAIT      0x00000200
 446 #define P_LIST_CHILDLKWAIT      0x00000400
 447 #define P_LIST_DEADPARENT       0x00000800
 448 #define P_LIST_PARENTREFWAIT    0x00001000
 449 #define P_LIST_INCREATE                 0x00002000
 450 /* 0x4000 &  0x8000 Not used */
 451 #define P_LIST_INHASH                   0x00010000      /* process is in hash */
 452 #define P_LIST_INPGRP                   0x00020000      /* process is in pgrp */
 453 #define P_LIST_PGRPTRANS                0x00040000      /* pgrp is getting replaced */
 454 #define P_LIST_PGRPTRWAIT               0x00080000      /* wait for pgrp replacement */
 455 #define P_LIST_EXITCOUNT                0x00100000      /* counted for process exit */
 456 #define P_LIST_REFWAIT                  0x00200000      /* wait to take a ref */
 457
 458
 459 /* local flags */
 460 #define P_LDELAYTERM    0x00000001      /* */
 461 #define P_LNOZOMB       0x00000002      /* */
 462 #define P_LTERM         0x00000004      /* */
 463 #define P_LEXIT         0x00000008      /* */
 464 #define P_LPEXIT        0x00000010
 465 #define P_LTRANSCOMMIT  0x00000020      /* process is committed to trans */
 466 #define P_LINTRANSIT    0x00000040      /* process in exec or in creation */
 467 #define P_LTRANSWAIT    0x00000080      /* waiting for trans to complete */
 468 #define P_LVFORK        0x00000100      /* parent proc of a vfork */
 469 #define P_LINVFORK      0x00000200      /* child proc of a vfork */
 470 #define P_LTRACED       0x00000400      /* */
 471 #define P_LSIGEXC       0x00000800      /* */
 472 #define P_LNOATTACH     0x00001000      /* */
 473 #define P_LPPWAIT       0x00002000      /* */
 474 #define P_LKQWDRAIN     0x00004000
 475 #define P_LKQWDRAINWAIT 0x00008000
 476 #define P_LKQWDEAD      0x00010000
 477 #define P_LLIMCHANGE    0x00020000      /* process is changing its plimit (rlim_cur, rlim_max) */
 478 #define P_LLIMWAIT      0x00040000
 479 #define P_LWAITED       0x00080000
 480 #define P_LINSIGNAL     0x00100000
 481 #define P_LCUSTOM_STACK 0x00200000      /* process is using custom stack size */
 482 #define P_LRAGE_VNODES  0x00400000
 483 #define P_LREGISTER     0x00800000      /* thread start fns registered  */
 484 #define P_LVMRSRCOWNER  0x01000000      /* can handle the resource ownership of  */
 485 #define P_LTERM_DECRYPTFAIL     0x04000000      /* process terminating due to key failure to decrypt */
 486 #define P_LTERM_JETSAM          0x08000000      /* process is being jetsam'd */
 487
 488 #define P_JETSAM_VMPAGESHORTAGE 0x00000000      /* jetsam: lowest jetsam priority proc, killed due to vm page shortage */
 489 #define P_JETSAM_VMTHRASHING    0x10000000      /* jetsam: lowest jetsam priority proc, killed due to vm thrashing */
 490 #define P_JETSAM_HIWAT          0x20000000      /* jetsam: high water mark */
 491 #define P_JETSAM_PID            0x30000000      /* jetsam: pid */
 492 #define P_JETSAM_IDLEEXIT       0x40000000      /* jetsam: idle exit */
 493 #define P_JETSAM_VNODE          0x50000000      /* jetsam: vnode kill */
 494 #define P_JETSAM_FCTHRASHING    0x60000000      /* jetsam: lowest jetsam priority proc, killed due to filecache thrashing */
 495 #define P_JETSAM_MASK           0x70000000      /* jetsam type mask */
 496 #define P_LNSPACE_RESOLVER      0x80000000      /* process is the namespace resolver */
 497
 498 /* Process control state for resource starvation */
 499 #define P_PCTHROTTLE    1
 500 #define P_PCSUSP        2
 501 #define P_PCKILL        3
 502 #define P_PCMAX         3
 503
 504 /* Process control action state on resrouce starvation */
 505 #define PROC_ACTION_MASK 0xffff0000;
 506 #define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX)
 507 #define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX)
 508 #define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16)))
 509 #define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p))
 510
 511 /* Process exit reason macros */
 512 #define PROC_HAS_EXITREASON(p) (p->p_exit_reason != OS_REASON_NULL)
 513 #define PROC_EXITREASON_FLAGS(p) p->p_exit_reason->osr_flags
 514
 515 /* additional process flags */
 516 #define P_LADVLOCK              0x01
 517 #define P_LXBKIDLEINPROG        0x02
 518
 519 /* p_vfs_iopolicy flags */
 520 #define P_VFS_IOPOLICY_FORCE_HFS_CASE_SENSITIVITY       0x0001
 521 #define P_VFS_IOPOLICY_ATIME_UPDATES                    0x0002
 522 #define P_VFS_IOPOLICY_MATERIALIZE_DATALESS_FILES       0x0004
 523 #define P_VFS_IOPOLICY_STATFS_NO_DATA_VOLUME            0x0008
 524 #define P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE          0x0010
 525 #define P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION        0x0020
 526 #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 | P_VFS_IOPOLICY_TRIGGER_RESOLVE_DISABLE | P_VFS_IOPOLICY_IGNORE_CONTENT_PROTECTION)
 527
 528 /* process creation arguments */
 529 #define PROC_CREATE_FORK        0       /* independent child (running) */
 530 #define PROC_CREATE_SPAWN       1       /* independent child (suspended) */
 531 #define PROC_CREATE_VFORK       2       /* child borrows context */
 532
 533 /* LP64 version of extern_proc.  all pointers
 534  * grow when we're dealing with a 64-bit process.
 535  * WARNING - keep in sync with extern_proc
 536  * but use native alignment of 64-bit process.
 537  */
 538
 539 #ifdef KERNEL
 540 #include <sys/time.h>   /* user_timeval, user_itimerval */
 541
 542 /*
 543  * This packing is required to ensure symmetry between userspace and kernelspace
 544  * when the kernel is 64-bit and the user application is 32-bit. All currently
 545  * supported ARM slices (arm64/armv7k/arm64_32) contain the same struct
 546  * alignment ABI so this packing isn't needed for ARM.
 547  */
 548 #if defined(__x86_64__)
 549 #pragma pack(4)
 550 #endif
 551 struct user32_extern_proc {
 552         union {
 553                 struct {
 554                         uint32_t __p_forw;      /* Doubly-linked run/sleep queue. */
 555                         uint32_t __p_back;
 556                 } p_st1;
 557                 struct user32_timeval __p_starttime;    /* process start time */
 558         } p_un;
 559         uint32_t        p_vmspace;      /* Address space. */
 560         uint32_t        p_sigacts;      /* Signal actions, state (PROC ONLY). */
 561         int             p_flag;                 /* P_* flags. */
 562         char    p_stat;                 /* S* process status. */
 563         pid_t   p_pid;                  /* Process identifier. */
 564         pid_t   p_oppid;                /* Save parent pid during ptrace. XXX */
 565         int             p_dupfd;                /* Sideways return value from fdopen. XXX */
 566         /* Mach related  */
 567         uint32_t user_stack;    /* where user stack was allocated */
 568         uint32_t exit_thread;  /* XXX Which thread is exiting? */
 569         int             p_debugger;             /* allow to debug */
 570         boolean_t       sigwait;        /* indication to suspend */
 571         /* scheduling */
 572         u_int   p_estcpu;        /* Time averaged value of p_cpticks. */
 573         int             p_cpticks;       /* Ticks of cpu time. */
 574         fixpt_t p_pctcpu;        /* %cpu for this process during p_swtime */
 575         uint32_t        p_wchan;         /* Sleep address. */
 576         uint32_t        p_wmesg;         /* Reason for sleep. */
 577         u_int   p_swtime;        /* Time swapped in or out. */
 578         u_int   p_slptime;       /* Time since last blocked. */
 579         struct  user32_itimerval p_realtimer;   /* Alarm timer. */
 580         struct  user32_timeval p_rtime; /* Real time. */
 581         u_quad_t p_uticks;              /* Statclock hits in user mode. */
 582         u_quad_t p_sticks;              /* Statclock hits in system mode. */
 583         u_quad_t p_iticks;              /* Statclock hits processing intr. */
 584         int             p_traceflag;            /* Kernel trace points. */
 585         uint32_t        p_tracep;       /* Trace to vnode. */
 586         int             p_siglist;              /* DEPRECATED */
 587         uint32_t        p_textvp;       /* Vnode of executable. */
 588         int             p_holdcnt;              /* If non-zero, don't swap. */
 589         sigset_t p_sigmask;     /* DEPRECATED. */
 590         sigset_t p_sigignore;   /* Signals being ignored. */
 591         sigset_t p_sigcatch;    /* Signals being caught by user. */
 592         u_char  p_priority;     /* Process priority. */
 593         u_char  p_usrpri;       /* User-priority based on p_cpu and p_nice. */
 594         char    p_nice;         /* Process "nice" value. */
 595         char    p_comm[MAXCOMLEN + 1];
 596         uint32_t        p_pgrp; /* Pointer to process group. */
 597         uint32_t        p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
 598         u_short p_xstat;        /* Exit status for wait; also stop signal. */
 599         u_short p_acflag;       /* Accounting flags. */
 600         uint32_t        p_ru;   /* Exit information. XXX */
 601 };
 602 #pragma pack()
 603 struct user64_extern_proc {
 604         union {
 605                 struct {
 606                         user_addr_t __p_forw;   /* Doubly-linked run/sleep queue. */
 607                         user_addr_t __p_back;
 608                 } p_st1;
 609                 struct user64_timeval __p_starttime;    /* process start time */
 610         } p_un;
 611         user_addr_t     p_vmspace;      /* Address space. */
 612         user_addr_t             p_sigacts;      /* Signal actions, state (PROC ONLY). */
 613         int             p_flag;                 /* P_* flags. */
 614         char    p_stat;                 /* S* process status. */
 615         pid_t   p_pid;                  /* Process identifier. */
 616         pid_t   p_oppid;                /* Save parent pid during ptrace. XXX */
 617         int             p_dupfd;                /* Sideways return value from fdopen. XXX */
 618         /* Mach related  */
 619         user_addr_t user_stack __attribute((aligned(8)));       /* where user stack was allocated */
 620         user_addr_t exit_thread;  /* XXX Which thread is exiting? */
 621         int             p_debugger;             /* allow to debug */
 622         boolean_t       sigwait;        /* indication to suspend */
 623         /* scheduling */
 624         u_int   p_estcpu;        /* Time averaged value of p_cpticks. */
 625         int             p_cpticks;       /* Ticks of cpu time. */
 626         fixpt_t p_pctcpu;        /* %cpu for this process during p_swtime */
 627         user_addr_t     p_wchan __attribute((aligned(8)));       /* Sleep address. */
 628         user_addr_t     p_wmesg;         /* Reason for sleep. */
 629         u_int   p_swtime;        /* Time swapped in or out. */
 630         u_int   p_slptime;       /* Time since last blocked. */
 631         struct  user64_itimerval p_realtimer;   /* Alarm timer. */
 632         struct  user64_timeval p_rtime; /* Real time. */
 633         u_quad_t p_uticks;              /* Statclock hits in user mode. */
 634         u_quad_t p_sticks;              /* Statclock hits in system mode. */
 635         u_quad_t p_iticks;              /* Statclock hits processing intr. */
 636         int             p_traceflag;            /* Kernel trace points. */
 637         user_addr_t     p_tracep __attribute((aligned(8)));     /* Trace to vnode. */
 638         int             p_siglist;              /* DEPRECATED */
 639         user_addr_t     p_textvp __attribute((aligned(8)));     /* Vnode of executable. */
 640         int             p_holdcnt;              /* If non-zero, don't swap. */
 641         sigset_t p_sigmask;     /* DEPRECATED. */
 642         sigset_t p_sigignore;   /* Signals being ignored. */
 643         sigset_t p_sigcatch;    /* Signals being caught by user. */
 644         u_char  p_priority;     /* Process priority. */
 645         u_char  p_usrpri;       /* User-priority based on p_cpu and p_nice. */
 646         char    p_nice;         /* Process "nice" value. */
 647         char    p_comm[MAXCOMLEN + 1];
 648         user_addr_t     p_pgrp __attribute((aligned(8)));       /* Pointer to process group. */
 649         user_addr_t     p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
 650         u_short p_xstat;        /* Exit status for wait; also stop signal. */
 651         u_short p_acflag;       /* Accounting flags. */
 652         user_addr_t     p_ru __attribute((aligned(8))); /* Exit information. XXX */
 653 };
 654 #endif  /* KERNEL */
 655
 656 #ifdef BSD_KERNEL_PRIVATE
 657
 658 #include <os/refcnt.h>    /* for struct os_refcnt pl_refcnt */
 659
 660 /*
 661  * Kernel shareable process resource limits:
 662  * Because this structure is moderately large but changed infrequently, it is normally
 663  * shared copy-on-write after a fork. The pl_refcnt variable records the number of
 664  * "processes" (NOT threads) currently sharing the plimit. A plimit is freed when the
 665  * last referencing process exits the system. The refcnt of the plimit is a race-free
 666  * _Atomic variable. We allocate new plimits in proc_limitupdate and free them
 667  * in proc_limitdrop/proc_limitupdate.
 668  */
 669 struct plimit {
 670         struct  rlimit   pl_rlimit[RLIM_NLIMITS];
 671         os_refcnt_t      pl_refcnt;                /* number of processes using this plimit */
 672 };
 673
 674 extern rlim_t proc_limitgetcur(proc_t p, int which, boolean_t to_lock_proc);
 675 extern void proc_limitsetcur_internal(proc_t p, int which, rlim_t value);
 676 extern struct proc proc0;
 677 #endif /* BSD_KERNEL_PRIVATE */
 678
 679 /*
 680  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
 681  * as it is used to represent "no process group".
 682  */
 683 extern int nprocs, maxproc;             /* Current and max number of procs. */
 684 extern int maxprocperuid;               /* Current number of procs per uid */
 685 extern int hard_maxproc;        /* hard limit */
 686 extern unsigned int proc_shutdown_exitcount;
 687
 688 #define PID_MAX         99999
 689 #define NO_PID          100000
 690 extern lck_mtx_t * proc_list_mlock;
 691 extern lck_mtx_t * proc_klist_mlock;
 692
 693 #define BSD_SIMUL_EXECS         33 /* 32 , allow for rounding */
 694 #define BSD_PAGEABLE_SIZE_PER_EXEC      (NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */
 695 extern int execargs_cache_size;
 696 extern int execargs_free_count;
 697 extern vm_offset_t * execargs_cache;
 698
 699 #define SESS_LEADER(p, sessp)   ((sessp)->s_leader == (p))
 700
 701 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
 702 extern LIST_HEAD(pidhashhead, proc) * pidhashtbl;
 703 extern u_long pidhash;
 704
 705 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
 706 extern LIST_HEAD(pgrphashhead, pgrp) * pgrphashtbl;
 707 extern u_long pgrphash;
 708 #define SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash])
 709 extern LIST_HEAD(sesshashhead, session) * sesshashtbl;
 710 extern u_long sesshash;
 711
 712 extern lck_grp_t * proc_lck_grp;
 713 extern lck_grp_t * proc_fdmlock_grp;
 714 extern lck_grp_t * proc_kqhashlock_grp;
 715 extern lck_grp_t * proc_knhashlock_grp;
 716 extern lck_grp_t * proc_mlock_grp;
 717 extern lck_grp_t * proc_ucred_mlock_grp;
 718 extern lck_grp_t * proc_slock_grp;
 719 extern lck_grp_t * proc_dirslock_grp;
 720 extern lck_grp_attr_t * proc_lck_grp_attr;
 721 extern lck_attr_t * proc_lck_attr;
 722
 723 LIST_HEAD(proclist, proc);
 724 extern struct proclist allproc;         /* List of all processes. */
 725 extern struct proclist zombproc;        /* List of zombie processes. */
 726
 727 extern struct proc * XNU_PTRAUTH_SIGNED_PTR("initproc") initproc;
 728 extern void procinit(void);
 729 extern void proc_lock(struct proc *);
 730 extern void proc_unlock(struct proc *);
 731 extern void proc_spinlock(struct proc *);
 732 extern void proc_spinunlock(struct proc *);
 733 extern void proc_list_lock(void);
 734 extern void proc_list_unlock(void);
 735 extern void proc_klist_lock(void);
 736 extern void proc_klist_unlock(void);
 737 extern void proc_fdlock(struct proc *);
 738 extern void proc_fdlock_spin(struct proc *);
 739 extern void proc_fdunlock(struct proc *);
 740 extern void proc_fdlock_assert(proc_t p, int assertflags);
 741 extern void proc_dirs_lock_shared(struct proc *);
 742 extern void proc_dirs_unlock_shared(struct proc *);
 743 extern void proc_dirs_lock_exclusive(struct proc *);
 744 extern void proc_dirs_unlock_exclusive(struct proc *);
 745 extern void proc_ucred_lock(struct proc *);
 746 extern void proc_ucred_unlock(struct proc *);
 747 __private_extern__ int proc_core_name(const char *name, uid_t uid, pid_t pid,
 748     char *cr_name, size_t cr_name_len);
 749 extern int isinferior(struct proc *, struct proc *);
 750 __private_extern__ struct proc *pzfind(pid_t);  /* Find zombie by id. */
 751 __private_extern__ struct proc *proc_find_zombref(pid_t);       /* Find zombie by id. */
 752 __private_extern__ void proc_drop_zombref(struct proc * p);     /* Find zombie by id. */
 753
 754 extern size_t   chgproccnt(uid_t uid, int diff);
 755 extern void     pinsertchild(struct proc *parent, struct proc *child);
 756 extern int      setsid_internal(struct proc *p);
 757 #ifndef __cplusplus
 758 extern void     setlogin_internal(proc_t p, const char login[static MAXLOGNAME]);
 759 #endif // __cplusplus
 760 extern int      setgroups_internal(proc_t p, u_int gidsetsize, gid_t *gidset, uid_t gmuid);
 761 extern int      enterpgrp(struct proc *p, pid_t pgid, int mksess);
 762 extern void     fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
 763 extern int      inferior(struct proc *p);
 764 extern int      leavepgrp(struct proc *p);
 765 extern void     resetpriority(struct proc *);
 766 extern void     setrunnable(struct proc *);
 767 extern void     setrunqueue(struct proc *);
 768 extern int      sleep(void *chan, int pri);
 769 extern int      tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int));
 770 extern int      tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int));
 771 extern int      msleep0(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, int timo, int (*continuation)(int));
 772 extern void     vfork_return(struct proc *child, int32_t *retval, int rval);
 773 extern int      exit1(struct proc *, int, int *);
 774 extern int      exit1_internal(struct proc *, int, int *, boolean_t, boolean_t, int);
 775 extern int      exit_with_reason(struct proc *, int, int *, boolean_t, boolean_t, int, struct os_reason *);
 776 extern int      fork1(proc_t, thread_t *, int, coalition_t *);
 777 extern void vfork_exit_internal(struct proc *p, int rv, int forced);
 778 extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked);
 779
 780 extern proc_t proc_findinternal(int pid, int locked);
 781 extern proc_t proc_findthread(thread_t thread);
 782 extern void proc_refdrain(proc_t);
 783 extern proc_t proc_refdrain_with_refwait(proc_t p, boolean_t get_ref_and_allow_wait);
 784 extern void proc_refwake(proc_t p);
 785 extern void proc_childdrainlocked(proc_t);
 786 extern void proc_childdrainstart(proc_t);
 787 extern void proc_childdrainend(proc_t);
 788 extern void  proc_checkdeadrefs(proc_t);
 789 struct proc *pfind_locked(pid_t);
 790 extern struct pgrp *pgfind(pid_t);
 791 extern void pg_rele(struct pgrp * pgrp);
 792 extern struct session * session_find_internal(pid_t sessid);
 793 extern struct pgrp * proc_pgrp(proc_t);
 794 extern struct pgrp * tty_pgrp(struct tty * tp);
 795 extern struct pgrp * pgfind_internal(pid_t);
 796 extern struct session * proc_session(proc_t);
 797 extern void pgrp_lock(struct pgrp * pgrp);
 798 extern void pgrp_unlock(struct pgrp * pgrp);
 799 extern void session_lock(struct session * sess);
 800 extern void session_unlock(struct session * sess);
 801 extern struct session * pgrp_session(struct pgrp * pgrp);
 802 extern void     session_rele(struct session *sess);
 803 extern int isbackground(proc_t p, struct tty  *tp);
 804 extern proc_t proc_parentholdref(proc_t);
 805 extern int proc_parentdropref(proc_t, int);
 806 int     itimerfix(struct timeval *tv);
 807 int     itimerdecr(struct proc * p, struct itimerval *itp, int usec);
 808 void    proc_free_realitimer(proc_t proc);
 809 int  timespec_is_valid(const struct timespec *);
 810 void proc_signalstart(struct proc *, int locked);
 811 void proc_signalend(struct proc *, int locked);
 812 int  proc_transstart(struct proc *, int locked, int non_blocking);
 813 void proc_transcommit(struct proc *, int locked);
 814 void proc_transend(struct proc *, int locked);
 815 int  proc_transwait(struct proc *, int locked);
 816 void  proc_rele_locked(struct proc *  p);
 817 struct proc *proc_ref_locked(struct proc *  p);
 818 void proc_knote(struct proc * p, long hint);
 819 void proc_knote_drain(struct proc *p);
 820 void proc_setregister(proc_t p);
 821 void proc_resetregister(proc_t p);
 822 /* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */
 823 thread_t proc_thread(proc_t);
 824 extern int proc_pendingsignals(proc_t, sigset_t);
 825 int proc_getpcontrol(int pid, int * pcontrolp);
 826 int proc_dopcontrol(proc_t p);
 827 int proc_resetpcontrol(int pid);
 828 #if PSYNCH
 829 void pth_proc_hashinit(proc_t);
 830 void pth_proc_hashdelete(proc_t);
 831 void pth_global_hashinit(void);
 832 extern thread_call_t psynch_thcall;
 833 void psynch_wq_cleanup(__unused void *  param, __unused void * param1);
 834 extern lck_mtx_t * pthread_list_mlock;
 835 #endif /* PSYNCH */
 836 struct uthread * current_uthread(void);
 837
 838
 839 /* process iteration */
 840
 841 #define ALLPROC_FOREACH(var) \
 842         LIST_FOREACH((var), &allproc, p_list)
 843
 844 #define ZOMBPROC_FOREACH(var) \
 845         LIST_FOREACH((var), &zombproc, p_list)
 846
 847 #define PGMEMBERS_FOREACH(group, var) \
 848         LIST_FOREACH((var), &((struct pgrp *)(group))->pg_members, p_pglist)
 849
 850 #define PCHILDREN_FOREACH(parent, var) \
 851         LIST_FOREACH((var), &(((struct proc *)(parent))->p_children), p_sibling)
 852
 853 typedef int (*proc_iterate_fn_t)(proc_t, void *);
 854
 855 /*
 856  * These are the only valid return values of `callout` functions provided to
 857  * process iterators.
 858  *
 859  * CLAIMED returns expect the caller to call proc_rele on the proc.  DONE
 860  * returns stop iterating processes early.
 861  */
 862 #define PROC_RETURNED      (0)
 863 #define PROC_RETURNED_DONE (1)
 864 #define PROC_CLAIMED       (2)
 865 #define PROC_CLAIMED_DONE  (3)
 866
 867 /*
 868  * pgrp_iterate walks the provided process group, calling `filterfn` with
 869  * `filterarg` for each process.  For processes where `filterfn` returned
 870  * non-zero, `callout` is called with `arg`.  If `PGRP_DROPREF` is supplied in
 871  * `flags`, a reference will be dropped from the process group after obtaining
 872  * the list of processes to call `callout` on.
 873  *
 874  * `PGMEMBERS_FOREACH` might also be used under the pgrp_lock to achieve a
 875  * similar effect.
 876  */
 877 #define PGRP_DROPREF (1)
 878
 879 extern void pgrp_iterate(struct pgrp *pgrp, unsigned int flags, proc_iterate_fn_t callout, void *arg, proc_iterate_fn_t filterfn, void *filterarg);
 880
 881 /*
 882  * proc_iterate walks the `allproc` and/or `zombproc` lists, calling `filterfn`
 883  * with `filterarg` for each process.  For processes where `filterfn` returned
 884  * non-zero, `callout` is called with `arg`.  If the `PROC_NOWAITTRANS` flag is
 885  * set, this function waits for transitions.
 886  *
 887  * `ALLPROC_FOREACH` or `ZOMBPROC_FOREACH` might also be used under the
 888  * `proc_list_lock` to achieve a similar effect.
 889  */
 890 #define PROC_ALLPROCLIST  (1U << 0) /* walk the allproc list (processes not yet exited) */
 891 #define PROC_ZOMBPROCLIST (1U << 1) /* walk the zombie list */
 892 #define PROC_NOWAITTRANS  (1U << 2) /* do not wait for transitions (checkdirs only) */
 893
 894 extern void proc_iterate(unsigned int flags, proc_iterate_fn_t callout, void *arg, proc_iterate_fn_t filterfn, void *filterarg);
 895
 896 /*
 897  * proc_childrenwalk walks the children of process `p`, calling `callout` for
 898  * each one.
 899  *
 900  * `PCHILDREN_FOREACH` might also be used under the `proc_list_lock` to achieve
 901  * a similar effect.
 902  */
 903 extern void proc_childrenwalk(proc_t p, proc_iterate_fn_t callout, void *arg);
 904
 905 /*
 906  * proc_rebootscan should only be used by kern_shutdown.c
 907  */
 908 extern void proc_rebootscan(proc_iterate_fn_t callout, void *arg, proc_iterate_fn_t filterfn, void *filterarg);
 909
 910 pid_t dtrace_proc_selfpid(void);
 911 pid_t dtrace_proc_selfppid(void);
 912 uid_t dtrace_proc_selfruid(void);
 913
 914 extern zone_t proc_zone;
 915 extern zone_t proc_stats_zone;
 916 extern zone_t proc_sigacts_zone;
 917
 918 extern struct proc_ident proc_ident(proc_t p);
 919
 920 #endif  /* !_SYS_PROC_INTERNAL_H_ */