sys/sys/proc.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1986, 1989, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)proc.h      8.15 (Berkeley) 5/19/95
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _SYS_PROC_H_
  41 #define _SYS_PROC_H_
  42
  43 #include <sys/callout.h>                /* For struct callout. */
  44 #include <sys/event.h>                  /* For struct klist. */
  45 #ifdef _KERNEL
  46 #include <sys/_eventhandler.h>
  47 #endif
  48 #include <sys/condvar.h>
  49 #ifndef _KERNEL
  50 #include <sys/filedesc.h>
  51 #endif
  52 #include <sys/queue.h>
  53 #include <sys/_lock.h>
  54 #include <sys/lock_profile.h>
  55 #include <sys/_mutex.h>
  56 #include <sys/osd.h>
  57 #include <sys/priority.h>
  58 #include <sys/rtprio.h>                 /* XXX. */
  59 #include <sys/runq.h>
  60 #include <sys/resource.h>
  61 #include <sys/sigio.h>
  62 #include <sys/signal.h>
  63 #include <sys/signalvar.h>
  64 #ifndef _KERNEL
  65 #include <sys/time.h>                   /* For structs itimerval, timeval. */
  66 #else
  67 #include <sys/pcpu.h>
  68 #include <sys/systm.h>
  69 #endif
  70 #include <sys/ucontext.h>
  71 #include <sys/ucred.h>
  72 #include <sys/types.h>
  73 #include <sys/_domainset.h>
  74
  75 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
  76 #ifdef _KERNEL
  77 #include <machine/cpu.h>
  78 #endif
  79
  80 /*
  81  * One structure allocated per session.
  82  *
  83  * List of locks
  84  * (m)          locked by s_mtx mtx
  85  * (e)          locked by proctree_lock sx
  86  * (c)          const until freeing
  87  */
  88 struct session {
  89         u_int           s_count;        /* Ref cnt; pgrps in session - atomic. */
  90         struct proc     *s_leader;      /* (m + e) Session leader. */
  91         struct vnode    *s_ttyvp;       /* (m) Vnode of controlling tty. */
  92         struct cdev_priv *s_ttydp;      /* (m) Device of controlling tty.  */
  93         struct tty      *s_ttyp;        /* (e) Controlling tty. */
  94         pid_t           s_sid;          /* (c) Session ID. */
  95                                         /* (m) Setlogin() name: */
  96         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
  97         struct mtx      s_mtx;          /* Mutex to protect members. */
  98 };
  99
 100 /*
 101  * One structure allocated per process group.
 102  *
 103  * List of locks
 104  * (m)          locked by pg_mtx mtx
 105  * (e)          locked by proctree_lock sx
 106  * (c)          const until freeing
 107  */
 108 struct pgrp {
 109         LIST_ENTRY(pgrp) pg_hash;       /* (e) Hash chain. */
 110         LIST_HEAD(, proc) pg_members;   /* (m + e) Pointer to pgrp members. */
 111         struct session  *pg_session;    /* (c) Pointer to session. */
 112         struct sigiolst pg_sigiolst;    /* (m) List of sigio sources. */
 113         pid_t           pg_id;          /* (c) Process group id. */
 114         int             pg_jobc;        /* (m) Job control process count. */
 115         struct mtx      pg_mtx;         /* Mutex to protect members */
 116 };
 117
 118 /*
 119  * pargs, used to hold a copy of the command line, if it had a sane length.
 120  */
 121 struct pargs {
 122         u_int   ar_ref;         /* Reference count. */
 123         u_int   ar_length;      /* Length. */
 124         u_char  ar_args[1];     /* Arguments. */
 125 };
 126
 127 /*-
 128  * Description of a process.
 129  *
 130  * This structure contains the information needed to manage a thread of
 131  * control, known in UN*X as a process; it has references to substructures
 132  * containing descriptions of things that the process uses, but may share
 133  * with related processes.  The process structure and the substructures
 134  * are always addressable except for those marked "(CPU)" below,
 135  * which might be addressable only on a processor on which the process
 136  * is running.
 137  *
 138  * Below is a key of locks used to protect each member of struct proc.  The
 139  * lock is indicated by a reference to a specific character in parens in the
 140  * associated comment.
 141  *      * - not yet protected
 142  *      a - only touched by curproc or parent during fork/wait
 143  *      b - created at fork, never changes
 144  *              (exception aiods switch vmspaces, but they are also
 145  *              marked 'P_SYSTEM' so hopefully it will be left alone)
 146  *      c - locked by proc mtx
 147  *      d - locked by allproc_lock lock
 148  *      e - locked by proctree_lock lock
 149  *      f - session mtx
 150  *      g - process group mtx
 151  *      h - callout_lock mtx
 152  *      i - by curproc or the master session mtx
 153  *      j - locked by proc slock
 154  *      k - only accessed by curthread
 155  *      k*- only accessed by curthread and from an interrupt
 156  *      kx- only accessed by curthread and by debugger
 157  *      l - the attaching proc or attaching proc parent
 158  *      m - Giant
 159  *      n - not locked, lazy
 160  *      o - ktrace lock
 161  *      q - td_contested lock
 162  *      r - p_peers lock
 163  *      s - see sleepq_switch(), sleeping_on_old_rtc(), and sleep(9)
 164  *      t - thread lock
 165  *      u - process stat lock
 166  *      w - process timer lock
 167  *      x - created at fork, only changes during single threading in exec
 168  *      y - created at first aio, doesn't change until exit or exec at which
 169  *          point we are single-threaded and only curthread changes it
 170  *      z - zombie threads lock
 171  *
 172  * If the locking key specifies two identifiers (for example, p_pptr) then
 173  * either lock is sufficient for read access, but both locks must be held
 174  * for write access.
 175  */
 176 struct cpuset;
 177 struct filecaps;
 178 struct filemon;
 179 struct kaioinfo;
 180 struct kaudit_record;
 181 struct kcov_info;
 182 struct kdtrace_proc;
 183 struct kdtrace_thread;
 184 struct mqueue_notifier;
 185 struct p_sched;
 186 struct proc;
 187 struct procdesc;
 188 struct racct;
 189 struct sbuf;
 190 struct sleepqueue;
 191 struct socket;
 192 struct syscall_args;
 193 struct td_sched;
 194 struct thread;
 195 struct trapframe;
 196 struct turnstile;
 197 struct vm_map;
 198 struct vm_map_entry;
 199 struct epoch_tracker;
 200
 201 /*
 202  * XXX: Does this belong in resource.h or resourcevar.h instead?
 203  * Resource usage extension.  The times in rusage structs in the kernel are
 204  * never up to date.  The actual times are kept as runtimes and tick counts
 205  * (with control info in the "previous" times), and are converted when
 206  * userland asks for rusage info.  Backwards compatibility prevents putting
 207  * this directly in the user-visible rusage struct.
 208  *
 209  * Locking for p_rux: (cu) means (u) for p_rux and (c) for p_crux.
 210  * Locking for td_rux: (t) for all fields.
 211  */
 212 struct rusage_ext {
 213         uint64_t        rux_runtime;    /* (cu) Real time. */
 214         uint64_t        rux_uticks;     /* (cu) Statclock hits in user mode. */
 215         uint64_t        rux_sticks;     /* (cu) Statclock hits in sys mode. */
 216         uint64_t        rux_iticks;     /* (cu) Statclock hits in intr mode. */
 217         uint64_t        rux_uu;         /* (c) Previous user time in usec. */
 218         uint64_t        rux_su;         /* (c) Previous sys time in usec. */
 219         uint64_t        rux_tu;         /* (c) Previous total time in usec. */
 220 };
 221
 222 /*
 223  * Kernel runnable context (thread).
 224  * This is what is put to sleep and reactivated.
 225  * Thread context.  Processes may have multiple threads.
 226  */
 227 struct thread {
 228         struct mtx      *volatile td_lock; /* replaces sched lock */
 229         struct proc     *td_proc;       /* (*) Associated process. */
 230         TAILQ_ENTRY(thread) td_plist;   /* (*) All threads in this proc. */
 231         TAILQ_ENTRY(thread) td_runq;    /* (t) Run queue. */
 232         union   {
 233                 TAILQ_ENTRY(thread) td_slpq;    /* (t) Sleep queue. */
 234                 struct thread *td_zombie; /* Zombie list linkage */
 235         };
 236         TAILQ_ENTRY(thread) td_lockq;   /* (t) Lock queue. */
 237         LIST_ENTRY(thread) td_hash;     /* (d) Hash chain. */
 238         struct cpuset   *td_cpuset;     /* (t) CPU affinity mask. */
 239         struct domainset_ref td_domain; /* (a) NUMA policy */
 240         struct seltd    *td_sel;        /* Select queue/channel. */
 241         struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
 242         struct turnstile *td_turnstile; /* (k) Associated turnstile. */
 243         struct rl_q_entry *td_rlqe;     /* (k) Associated range lock entry. */
 244         struct umtx_q   *td_umtxq;      /* (c?) Link for when we're blocked. */
 245         lwpid_t         td_tid;         /* (b) Thread ID. */
 246         sigqueue_t      td_sigqueue;    /* (c) Sigs arrived, not delivered. */
 247 #define td_siglist      td_sigqueue.sq_signals
 248         u_char          td_lend_user_pri; /* (t) Lend user pri. */
 249         u_char          td_allocdomain; /* (b) NUMA domain backing this struct thread. */
 250
 251 /* Cleared during fork1() */
 252 #define td_startzero td_flags
 253         int             td_flags;       /* (t) TDF_* flags. */
 254         int             td_inhibitors;  /* (t) Why can not run. */
 255         int             td_pflags;      /* (k) Private thread (TDP_*) flags. */
 256         int             td_pflags2;     /* (k) Private thread (TDP2_*) flags. */
 257         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
 258         int             td_sqqueue;     /* (t) Sleepqueue queue blocked on. */
 259         const void      *td_wchan;      /* (t) Sleep address. */
 260         const char      *td_wmesg;      /* (t) Reason for sleep. */
 261         volatile u_char td_owepreempt;  /* (k*) Preempt on last critical_exit */
 262         u_char          td_tsqueue;     /* (t) Turnstile queue blocked on. */
 263         short           td_locks;       /* (k) Debug: count of non-spin locks */
 264         short           td_rw_rlocks;   /* (k) Count of rwlock read locks. */
 265         short           td_sx_slocks;   /* (k) Count of sx shared locks. */
 266         short           td_lk_slocks;   /* (k) Count of lockmgr shared locks. */
 267         short           td_stopsched;   /* (k) Scheduler stopped. */
 268         struct turnstile *td_blocked;   /* (t) Lock thread is blocked on. */
 269         const char      *td_lockname;   /* (t) Name of lock blocked on. */
 270         LIST_HEAD(, turnstile) td_contested;    /* (q) Contested locks. */
 271         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
 272         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
 273         int             td_pinned;      /* (k) Temporary cpu pin count. */
 274         struct ucred    *td_realucred;  /* (k) Reference to credentials. */
 275         struct ucred    *td_ucred;      /* (k) Used credentials, temporarily switchable. */
 276         struct plimit   *td_limit;      /* (k) Resource limits. */
 277         int             td_slptick;     /* (t) Time at sleep. */
 278         int             td_blktick;     /* (t) Time spent blocked. */
 279         int             td_swvoltick;   /* (t) Time at last SW_VOL switch. */
 280         int             td_swinvoltick; /* (t) Time at last SW_INVOL switch. */
 281         u_int           td_cow;         /* (*) Number of copy-on-write faults */
 282         struct rusage   td_ru;          /* (t) rusage information. */
 283         struct rusage_ext td_rux;       /* (t) Internal rusage information. */
 284         uint64_t        td_incruntime;  /* (t) Cpu ticks to transfer to proc. */
 285         uint64_t        td_runtime;     /* (t) How many cpu ticks we've run. */
 286         u_int           td_pticks;      /* (t) Statclock hits for profiling */
 287         u_int           td_sticks;      /* (t) Statclock hits in system mode. */
 288         u_int           td_iticks;      /* (t) Statclock hits in intr mode. */
 289         u_int           td_uticks;      /* (t) Statclock hits in user mode. */
 290         int             td_intrval;     /* (t) Return value for sleepq. */
 291         sigset_t        td_oldsigmask;  /* (k) Saved mask from pre sigpause. */
 292         volatile u_int  td_generation;  /* (k) For detection of preemption */
 293         stack_t         td_sigstk;      /* (k) Stack ptr and on-stack flag. */
 294         int             td_xsig;        /* (c) Signal for ptrace */
 295         u_long          td_profil_addr; /* (k) Temporary addr until AST. */
 296         u_int           td_profil_ticks; /* (k) Temporary ticks until AST. */
 297         char            td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
 298         struct file     *td_fpop;       /* (k) file referencing cdev under op */
 299         int             td_dbgflags;    /* (c) Userland debugger flags */
 300         siginfo_t       td_si;          /* (c) For debugger or core file */
 301         int             td_ng_outbound; /* (k) Thread entered ng from above. */
 302         struct osd      td_osd;         /* (k) Object specific data. */
 303         struct vm_map_entry *td_map_def_user; /* (k) Deferred entries. */
 304         pid_t           td_dbg_forked;  /* (c) Child pid for debugger. */
 305         struct vnode    *td_vp_reserved;/* (k) Prealloated vnode. */
 306         u_int           td_no_sleeping; /* (k) Sleeping disabled count. */
 307         void            *td_su;         /* (k) FFS SU private */
 308         sbintime_t      td_sleeptimo;   /* (t) Sleep timeout. */
 309         int             td_rtcgen;      /* (s) rtc_generation of abs. sleep */
 310         int             td_errno;       /* (k) Error from last syscall. */
 311         size_t          td_vslock_sz;   /* (k) amount of vslock-ed space */
 312         struct kcov_info *td_kcov_info; /* (*) Kernel code coverage data */
 313         u_int           td_ucredref;    /* (k) references on td_realucred */
 314 #define td_endzero td_sigmask
 315
 316 /* Copied during fork1() or create_thread(). */
 317 #define td_startcopy td_endzero
 318         sigset_t        td_sigmask;     /* (c) Current signal mask. */
 319         u_char          td_rqindex;     /* (t) Run queue index. */
 320         u_char          td_base_pri;    /* (t) Thread base kernel priority. */
 321         u_char          td_priority;    /* (t) Thread active priority. */
 322         u_char          td_pri_class;   /* (t) Scheduling class. */
 323         u_char          td_user_pri;    /* (t) User pri from estcpu and nice. */
 324         u_char          td_base_user_pri; /* (t) Base user pri */
 325         u_char          td_pre_epoch_prio; /* (k) User pri on entry to epoch */
 326         uintptr_t       td_rb_list;     /* (k) Robust list head. */
 327         uintptr_t       td_rbp_list;    /* (k) Robust priv list head. */
 328         uintptr_t       td_rb_inact;    /* (k) Current in-action mutex loc. */
 329         struct syscall_args td_sa;      /* (kx) Syscall parameters. Copied on
 330                                            fork for child tracing. */
 331         void            *td_sigblock_ptr; /* (k) uptr for fast sigblock. */
 332         uint32_t        td_sigblock_val;  /* (k) fast sigblock value read at
 333                                              td_sigblock_ptr on kern entry */
 334 #define td_endcopy td_pcb
 335
 336 /*
 337  * Fields that must be manually set in fork1() or create_thread()
 338  * or already have been set in the allocator, constructor, etc.
 339  */
 340         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
 341         enum td_states {
 342                 TDS_INACTIVE = 0x0,
 343                 TDS_INHIBITED,
 344                 TDS_CAN_RUN,
 345                 TDS_RUNQ,
 346                 TDS_RUNNING
 347         } td_state;                     /* (t) thread state */
 348         union {
 349                 register_t      tdu_retval[2];
 350                 off_t           tdu_off;
 351         } td_uretoff;                   /* (k) Syscall aux returns. */
 352 #define td_retval       td_uretoff.tdu_retval
 353         u_int           td_cowgen;      /* (k) Generation of COW pointers. */
 354         /* LP64 hole */
 355         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
 356         struct trapframe *td_frame;     /* (k) */
 357         vm_offset_t     td_kstack;      /* (a) Kernel VA of kstack. */
 358         int             td_kstack_pages; /* (a) Size of the kstack. */
 359         volatile u_int  td_critnest;    /* (k*) Critical section nest level. */
 360         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
 361         struct kaudit_record    *td_ar; /* (k) Active audit record, if any. */
 362         struct lpohead  td_lprof[2];    /* (a) lock profiling objects. */
 363         struct kdtrace_thread   *td_dtrace; /* (*) DTrace-specific data. */
 364         struct vnet     *td_vnet;       /* (k) Effective vnet. */
 365         const char      *td_vnet_lpush; /* (k) Debugging vnet push / pop. */
 366         struct trapframe *td_intr_frame;/* (k) Frame of the current irq */
 367         struct proc     *td_rfppwait_p; /* (k) The vforked child */
 368         struct vm_page  **td_ma;        /* (k) uio pages held */
 369         int             td_ma_cnt;      /* (k) size of *td_ma */
 370         /* LP64 hole */
 371         void            *td_emuldata;   /* Emulator state data */
 372         int             td_lastcpu;     /* (t) Last cpu we were on. */
 373         int             td_oncpu;       /* (t) Which cpu we are on. */
 374         void            *td_lkpi_task;  /* LinuxKPI task struct pointer */
 375         int             td_pmcpend;
 376 #ifdef EPOCH_TRACE
 377         SLIST_HEAD(, epoch_tracker) td_epochs;
 378 #endif
 379 };
 380
 381 struct thread0_storage {
 382         struct thread t0st_thread;
 383         uint64_t t0st_sched[10];
 384 };
 385
 386 struct mtx *thread_lock_block(struct thread *);
 387 void thread_lock_block_wait(struct thread *);
 388 void thread_lock_set(struct thread *, struct mtx *);
 389 void thread_lock_unblock(struct thread *, struct mtx *);
 390 #define THREAD_LOCK_ASSERT(td, type)                                    \
 391         mtx_assert((td)->td_lock, (type))
 392
 393 #define THREAD_LOCK_BLOCKED_ASSERT(td, type)                            \
 394 do {                                                                    \
 395         struct mtx *__m = (td)->td_lock;                                \
 396         if (__m != &blocked_lock)                                       \
 397                 mtx_assert(__m, (type));                                \
 398 } while (0)
 399
 400 #ifdef INVARIANTS
 401 #define THREAD_LOCKPTR_ASSERT(td, lock)                                 \
 402 do {                                                                    \
 403         struct mtx *__m;                                                \
 404         __m = (td)->td_lock;                                            \
 405         KASSERT(__m == (lock),                                          \
 406             ("Thread %p lock %p does not match %p", td, __m, (lock)));  \
 407 } while (0)
 408
 409 #define THREAD_LOCKPTR_BLOCKED_ASSERT(td, lock)                         \
 410 do {                                                                    \
 411         struct mtx *__m;                                                \
 412         __m = (td)->td_lock;                                            \
 413         KASSERT(__m == (lock) || __m == &blocked_lock,                  \
 414             ("Thread %p lock %p does not match %p", td, __m, (lock)));  \
 415 } while (0)
 416
 417 #define TD_LOCKS_INC(td)        ((td)->td_locks++)
 418 #define TD_LOCKS_DEC(td) do {                                           \
 419         KASSERT(SCHEDULER_STOPPED_TD(td) || (td)->td_locks > 0,         \
 420             ("thread %p owns no locks", (td)));                         \
 421         (td)->td_locks--;                                               \
 422 } while (0)
 423 #else
 424 #define THREAD_LOCKPTR_ASSERT(td, lock)
 425 #define THREAD_LOCKPTR_BLOCKED_ASSERT(td, lock)
 426
 427 #define TD_LOCKS_INC(td)
 428 #define TD_LOCKS_DEC(td)
 429 #endif
 430
 431 /*
 432  * Flags kept in td_flags:
 433  * To change these you MUST have the scheduler lock.
 434  */
 435 #define TDF_BORROWING   0x00000001 /* Thread is borrowing pri from another. */
 436 #define TDF_INPANIC     0x00000002 /* Caused a panic, let it drive crashdump. */
 437 #define TDF_INMEM       0x00000004 /* Thread's stack is in memory. */
 438 #define TDF_SINTR       0x00000008 /* Sleep is interruptible. */
 439 #define TDF_TIMEOUT     0x00000010 /* Timing out during sleep. */
 440 #define TDF_IDLETD      0x00000020 /* This is a per-CPU idle thread. */
 441 #define TDF_CANSWAP     0x00000040 /* Thread can be swapped. */
 442 #define TDF_UNUSED80    0x00000080 /* unused. */
 443 #define TDF_KTH_SUSP    0x00000100 /* kthread is suspended */
 444 #define TDF_ALLPROCSUSP 0x00000200 /* suspended by SINGLE_ALLPROC */
 445 #define TDF_BOUNDARY    0x00000400 /* Thread suspended at user boundary */
 446 #define TDF_ASTPENDING  0x00000800 /* Thread has some asynchronous events. */
 447 #define TDF_UNUSED12    0x00001000 /* --available-- */
 448 #define TDF_SBDRY       0x00002000 /* Stop only on usermode boundary. */
 449 #define TDF_UPIBLOCKED  0x00004000 /* Thread blocked on user PI mutex. */
 450 #define TDF_NEEDSUSPCHK 0x00008000 /* Thread may need to suspend. */
 451 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
 452 #define TDF_NEEDSIGCHK  0x00020000 /* Thread may need signal delivery. */
 453 #define TDF_NOLOAD      0x00040000 /* Ignore during load avg calculations. */
 454 #define TDF_SERESTART   0x00080000 /* ERESTART on stop attempts. */
 455 #define TDF_THRWAKEUP   0x00100000 /* Libthr thread must not suspend itself. */
 456 #define TDF_SEINTR      0x00200000 /* EINTR on stop attempts. */
 457 #define TDF_SWAPINREQ   0x00400000 /* Swapin request due to wakeup. */
 458 #define TDF_UNUSED23    0x00800000 /* --available-- */
 459 #define TDF_SCHED0      0x01000000 /* Reserved for scheduler private use */
 460 #define TDF_SCHED1      0x02000000 /* Reserved for scheduler private use */
 461 #define TDF_SCHED2      0x04000000 /* Reserved for scheduler private use */
 462 #define TDF_SCHED3      0x08000000 /* Reserved for scheduler private use */
 463 #define TDF_ALRMPEND    0x10000000 /* Pending SIGVTALRM needs to be posted. */
 464 #define TDF_PROFPEND    0x20000000 /* Pending SIGPROF needs to be posted. */
 465 #define TDF_MACPEND     0x40000000 /* AST-based MAC event pending. */
 466
 467 /* Userland debug flags */
 468 #define TDB_SUSPEND     0x00000001 /* Thread is suspended by debugger */
 469 #define TDB_XSIG        0x00000002 /* Thread is exchanging signal under trace */
 470 #define TDB_USERWR      0x00000004 /* Debugger modified memory or registers */
 471 #define TDB_SCE         0x00000008 /* Thread performs syscall enter */
 472 #define TDB_SCX         0x00000010 /* Thread performs syscall exit */
 473 #define TDB_EXEC        0x00000020 /* TDB_SCX from exec(2) family */
 474 #define TDB_FORK        0x00000040 /* TDB_SCX from fork(2) that created new
 475                                       process */
 476 #define TDB_STOPATFORK  0x00000080 /* Stop at the return from fork (child
 477                                       only) */
 478 #define TDB_CHILD       0x00000100 /* New child indicator for ptrace() */
 479 #define TDB_BORN        0x00000200 /* New LWP indicator for ptrace() */
 480 #define TDB_EXIT        0x00000400 /* Exiting LWP indicator for ptrace() */
 481 #define TDB_VFORK       0x00000800 /* vfork indicator for ptrace() */
 482 #define TDB_FSTP        0x00001000 /* The thread is PT_ATTACH leader */
 483 #define TDB_STEP        0x00002000 /* (x86) PSL_T set for PT_STEP */
 484
 485 /*
 486  * "Private" flags kept in td_pflags:
 487  * These are only written by curthread and thus need no locking.
 488  */
 489 #define TDP_OLDMASK     0x00000001 /* Need to restore mask after suspend. */
 490 #define TDP_INKTR       0x00000002 /* Thread is currently in KTR code. */
 491 #define TDP_INKTRACE    0x00000004 /* Thread is currently in KTRACE code. */
 492 #define TDP_BUFNEED     0x00000008 /* Do not recurse into the buf flush */
 493 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
 494 #define TDP_ALTSTACK    0x00000020 /* Have alternate signal stack. */
 495 #define TDP_DEADLKTREAT 0x00000040 /* Lock acquisition - deadlock treatment. */
 496 #define TDP_NOFAULTING  0x00000080 /* Do not handle page faults. */
 497 #define TDP_SIGFASTBLOCK 0x00000100 /* Fast sigblock active */
 498 #define TDP_OWEUPC      0x00000200 /* Call addupc() at next AST. */
 499 #define TDP_ITHREAD     0x00000400 /* Thread is an interrupt thread. */
 500 #define TDP_SYNCIO      0x00000800 /* Local override, disable async i/o. */
 501 #define TDP_SCHED1      0x00001000 /* Reserved for scheduler private use */
 502 #define TDP_SCHED2      0x00002000 /* Reserved for scheduler private use */
 503 #define TDP_SCHED3      0x00004000 /* Reserved for scheduler private use */
 504 #define TDP_SCHED4      0x00008000 /* Reserved for scheduler private use */
 505 #define TDP_GEOM        0x00010000 /* Settle GEOM before finishing syscall */
 506 #define TDP_SOFTDEP     0x00020000 /* Stuck processing softdep worklist */
 507 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
 508 #define TDP_WAKEUP      0x00080000 /* Don't sleep in umtx cond_wait */
 509 #define TDP_INBDFLUSH   0x00100000 /* Already in BO_BDFLUSH, do not recurse */
 510 #define TDP_KTHREAD     0x00200000 /* This is an official kernel thread */
 511 #define TDP_CALLCHAIN   0x00400000 /* Capture thread's callchain */
 512 #define TDP_IGNSUSP     0x00800000 /* Permission to ignore the MNTK_SUSPEND* */
 513 #define TDP_AUDITREC    0x01000000 /* Audit record pending on thread */
 514 #define TDP_RFPPWAIT    0x02000000 /* Handle RFPPWAIT on syscall exit */
 515 #define TDP_RESETSPUR   0x04000000 /* Reset spurious page fault history. */
 516 #define TDP_NERRNO      0x08000000 /* Last errno is already in td_errno */
 517 #define TDP_UIOHELD     0x10000000 /* Current uio has pages held in td_ma */
 518 #define TDP_FORKING     0x20000000 /* Thread is being created through fork() */
 519 #define TDP_EXECVMSPC   0x40000000 /* Execve destroyed old vmspace */
 520 #define TDP_SIGFASTPENDING 0x80000000 /* Pending signal due to sigfastblock */
 521
 522 #define TDP2_SBPAGES    0x00000001 /* Owns sbusy on some pages */
 523 #define TDP2_COMPAT32RB 0x00000002 /* compat32 ABI for robust lists */
 524
 525 /*
 526  * Reasons that the current thread can not be run yet.
 527  * More than one may apply.
 528  */
 529 #define TDI_SUSPENDED   0x0001  /* On suspension queue. */
 530 #define TDI_SLEEPING    0x0002  /* Actually asleep! (tricky). */
 531 #define TDI_SWAPPED     0x0004  /* Stack not in mem.  Bad juju if run. */
 532 #define TDI_LOCK        0x0008  /* Stopped on a lock. */
 533 #define TDI_IWAIT       0x0010  /* Awaiting interrupt. */
 534
 535 #define TD_IS_SLEEPING(td)      ((td)->td_inhibitors & TDI_SLEEPING)
 536 #define TD_ON_SLEEPQ(td)        ((td)->td_wchan != NULL)
 537 #define TD_IS_SUSPENDED(td)     ((td)->td_inhibitors & TDI_SUSPENDED)
 538 #define TD_IS_SWAPPED(td)       ((td)->td_inhibitors & TDI_SWAPPED)
 539 #define TD_ON_LOCK(td)          ((td)->td_inhibitors & TDI_LOCK)
 540 #define TD_AWAITING_INTR(td)    ((td)->td_inhibitors & TDI_IWAIT)
 541 #define TD_IS_RUNNING(td)       ((td)->td_state == TDS_RUNNING)
 542 #define TD_ON_RUNQ(td)          ((td)->td_state == TDS_RUNQ)
 543 #define TD_CAN_RUN(td)          ((td)->td_state == TDS_CAN_RUN)
 544 #define TD_IS_INHIBITED(td)     ((td)->td_state == TDS_INHIBITED)
 545 #define TD_ON_UPILOCK(td)       ((td)->td_flags & TDF_UPIBLOCKED)
 546 #define TD_IS_IDLETHREAD(td)    ((td)->td_flags & TDF_IDLETD)
 547
 548 #define TD_CAN_ABORT(td)        (TD_ON_SLEEPQ((td)) &&                  \
 549                                     ((td)->td_flags & TDF_SINTR) != 0)
 550
 551 #define KTDSTATE(td)                                                    \
 552         (((td)->td_inhibitors & TDI_SLEEPING) != 0 ? "sleep"  :         \
 553         ((td)->td_inhibitors & TDI_SUSPENDED) != 0 ? "suspended" :      \
 554         ((td)->td_inhibitors & TDI_SWAPPED) != 0 ? "swapped" :          \
 555         ((td)->td_inhibitors & TDI_LOCK) != 0 ? "blocked" :             \
 556         ((td)->td_inhibitors & TDI_IWAIT) != 0 ? "iwait" : "yielding")
 557
 558 #define TD_SET_INHIB(td, inhib) do {                    \
 559         (td)->td_state = TDS_INHIBITED;                 \
 560         (td)->td_inhibitors |= (inhib);                 \
 561 } while (0)
 562
 563 #define TD_CLR_INHIB(td, inhib) do {                    \
 564         if (((td)->td_inhibitors & (inhib)) &&          \
 565             (((td)->td_inhibitors &= ~(inhib)) == 0))   \
 566                 (td)->td_state = TDS_CAN_RUN;           \
 567 } while (0)
 568
 569 #define TD_SET_SLEEPING(td)     TD_SET_INHIB((td), TDI_SLEEPING)
 570 #define TD_SET_SWAPPED(td)      TD_SET_INHIB((td), TDI_SWAPPED)
 571 #define TD_SET_LOCK(td)         TD_SET_INHIB((td), TDI_LOCK)
 572 #define TD_SET_SUSPENDED(td)    TD_SET_INHIB((td), TDI_SUSPENDED)
 573 #define TD_SET_IWAIT(td)        TD_SET_INHIB((td), TDI_IWAIT)
 574 #define TD_SET_EXITING(td)      TD_SET_INHIB((td), TDI_EXITING)
 575
 576 #define TD_CLR_SLEEPING(td)     TD_CLR_INHIB((td), TDI_SLEEPING)
 577 #define TD_CLR_SWAPPED(td)      TD_CLR_INHIB((td), TDI_SWAPPED)
 578 #define TD_CLR_LOCK(td)         TD_CLR_INHIB((td), TDI_LOCK)
 579 #define TD_CLR_SUSPENDED(td)    TD_CLR_INHIB((td), TDI_SUSPENDED)
 580 #define TD_CLR_IWAIT(td)        TD_CLR_INHIB((td), TDI_IWAIT)
 581
 582 #define TD_SET_RUNNING(td)      (td)->td_state = TDS_RUNNING
 583 #define TD_SET_RUNQ(td)         (td)->td_state = TDS_RUNQ
 584 #define TD_SET_CAN_RUN(td)      (td)->td_state = TDS_CAN_RUN
 585
 586 #define TD_SBDRY_INTR(td) \
 587     (((td)->td_flags & (TDF_SEINTR | TDF_SERESTART)) != 0)
 588 #define TD_SBDRY_ERRNO(td) \
 589     (((td)->td_flags & TDF_SEINTR) != 0 ? EINTR : ERESTART)
 590
 591 /*
 592  * Process structure.
 593  */
 594 struct proc {
 595         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
 596         TAILQ_HEAD(, thread) p_threads; /* (c) all threads. */
 597         struct mtx      p_slock;        /* process spin lock */
 598         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
 599         struct filedesc *p_fd;          /* (b) Open files. */
 600         struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
 601         struct pwddesc  *p_pd;          /* (b) Cwd, chroot, jail, umask */
 602         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
 603         struct plimit   *p_limit;       /* (c) Resource limits. */
 604         struct callout  p_limco;        /* (c) Limit callout handle */
 605         struct sigacts  *p_sigacts;     /* (x) Signal actions, state (CPU). */
 606
 607         int             p_flag;         /* (c) P_* flags. */
 608         int             p_flag2;        /* (c) P2_* flags. */
 609         enum p_states {
 610                 PRS_NEW = 0,            /* In creation */
 611                 PRS_NORMAL,             /* threads can be run. */
 612                 PRS_ZOMBIE
 613         } p_state;                      /* (j/c) Process status. */
 614         pid_t           p_pid;          /* (b) Process identifier. */
 615         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
 616         LIST_ENTRY(proc) p_pglist;      /* (g + e) List of processes in pgrp. */
 617         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
 618         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
 619         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
 620         struct proc     *p_reaper;      /* (e) My reaper. */
 621         LIST_HEAD(, proc) p_reaplist;   /* (e) List of my descendants
 622                                                (if I am reaper). */
 623         LIST_ENTRY(proc) p_reapsibling; /* (e) List of siblings - descendants of
 624                                                the same reaper. */
 625         struct mtx      p_mtx;          /* (n) Lock for this struct. */
 626         struct mtx      p_statmtx;      /* Lock for the stats */
 627         struct mtx      p_itimmtx;      /* Lock for the virt/prof timers */
 628         struct mtx      p_profmtx;      /* Lock for the profiling */
 629         struct ksiginfo *p_ksi; /* Locked by parent proc lock */
 630         sigqueue_t      p_sigqueue;     /* (c) Sigs not delivered to a td. */
 631 #define p_siglist       p_sigqueue.sq_signals
 632         pid_t           p_oppid;        /* (c + e) Real parent pid. */
 633
 634 /* The following fields are all zeroed upon creation in fork. */
 635 #define p_startzero     p_vmspace
 636         struct vmspace  *p_vmspace;     /* (b) Address space. */
 637         u_int           p_swtick;       /* (c) Tick when swapped in or out. */
 638         u_int           p_cowgen;       /* (c) Generation of COW pointers. */
 639         struct itimerval p_realtimer;   /* (c) Alarm timer. */
 640         struct rusage   p_ru;           /* (a) Exit information. */
 641         struct rusage_ext p_rux;        /* (cu) Internal resource usage. */
 642         struct rusage_ext p_crux;       /* (c) Internal child resource usage. */
 643         int             p_profthreads;  /* (c) Num threads in addupc_task. */
 644         volatile int    p_exitthreads;  /* (j) Number of threads exiting */
 645         int             p_traceflag;    /* (o) Kernel trace points. */
 646         struct vnode    *p_tracevp;     /* (c + o) Trace to vnode. */
 647         struct ucred    *p_tracecred;   /* (o) Credentials to trace with. */
 648         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
 649         u_int           p_lock;         /* (c) Proclock (prevent swap) count. */
 650         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
 651         int             p_sigparent;    /* (c) Signal to parent on exit. */
 652         int             p_sig;          /* (n) For core dump/debugger XXX. */
 653         u_int           p_ptevents;     /* (c + e) ptrace() event mask. */
 654         struct kaioinfo *p_aioinfo;     /* (y) ASYNC I/O info. */
 655         struct thread   *p_singlethread;/* (c + j) If single threading this is it */
 656         int             p_suspcount;    /* (j) Num threads in suspended mode. */
 657         struct thread   *p_xthread;     /* (c) Trap thread */
 658         int             p_boundary_count;/* (j) Num threads at user boundary */
 659         int             p_pendingcnt;   /* how many signals are pending */
 660         struct itimers  *p_itimers;     /* (c) POSIX interval timers. */
 661         struct procdesc *p_procdesc;    /* (e) Process descriptor, if any. */
 662         u_int           p_treeflag;     /* (e) P_TREE flags */
 663         int             p_pendingexits; /* (c) Count of pending thread exits. */
 664         struct filemon  *p_filemon;     /* (c) filemon-specific data. */
 665         int             p_pdeathsig;    /* (c) Signal from parent on exit. */
 666 /* End area that is zeroed on creation. */
 667 #define p_endzero       p_magic
 668
 669 /* The following fields are all copied upon creation in fork. */
 670 #define p_startcopy     p_endzero
 671         u_int           p_magic;        /* (b) Magic number. */
 672         int             p_osrel;        /* (x) osreldate for the
 673                                                binary (from ELF note, if any) */
 674         uint32_t        p_fctl0;        /* (x) ABI feature control, ELF note */
 675         char            p_comm[MAXCOMLEN + 1];  /* (x) Process name. */
 676         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
 677         struct pargs    *p_args;        /* (c) Process arguments. */
 678         rlim_t          p_cpulimit;     /* (c) Current CPU limit in seconds. */
 679         signed char     p_nice;         /* (c) Process "nice" value. */
 680         int             p_fibnum;       /* in this routing domain XXX MRT */
 681         pid_t           p_reapsubtree;  /* (e) Pid of the direct child of the
 682                                                reaper which spawned
 683                                                our subtree. */
 684         uint16_t        p_elf_machine;  /* (x) ELF machine type */
 685         uint64_t        p_elf_flags;    /* (x) ELF flags */
 686 /* End area that is copied on creation. */
 687 #define p_endcopy       p_xexit
 688
 689         u_int           p_xexit;        /* (c) Exit code. */
 690         u_int           p_xsig;         /* (c) Stop/kill sig. */
 691         struct pgrp     *p_pgrp;        /* (c + e) Pointer to process group. */
 692         struct knlist   *p_klist;       /* (c) Knotes attached to this proc. */
 693         int             p_numthreads;   /* (c) Number of threads. */
 694         struct mdproc   p_md;           /* Any machine-dependent fields. */
 695         struct callout  p_itcallout;    /* (h + c) Interval timer callout. */
 696         u_short         p_acflag;       /* (c) Accounting flags. */
 697         struct proc     *p_peers;       /* (r) */
 698         struct proc     *p_leader;      /* (b) */
 699         void            *p_emuldata;    /* (c) Emulator state data. */
 700         struct label    *p_label;       /* (*) Proc (not subject) MAC label. */
 701         STAILQ_HEAD(, ktr_request)      p_ktr;  /* (o) KTR event queue. */
 702         LIST_HEAD(, mqueue_notifier)    p_mqnotifier; /* (c) mqueue notifiers.*/
 703         struct kdtrace_proc     *p_dtrace; /* (*) DTrace-specific data. */
 704         struct cv       p_pwait;        /* (*) wait cv for exit/exec. */
 705         uint64_t        p_prev_runtime; /* (c) Resource usage accounting. */
 706         struct racct    *p_racct;       /* (b) Resource accounting. */
 707         int             p_throttled;    /* (c) Flag for racct pcpu throttling */
 708         /*
 709          * An orphan is the child that has been re-parented to the
 710          * debugger as a result of attaching to it.  Need to keep
 711          * track of them for parent to be able to collect the exit
 712          * status of what used to be children.
 713          */
 714         LIST_ENTRY(proc) p_orphan;      /* (e) List of orphan processes. */
 715         LIST_HEAD(, proc) p_orphans;    /* (e) Pointer to list of orphans. */
 716 };
 717
 718 #define p_session       p_pgrp->pg_session
 719 #define p_pgid          p_pgrp->pg_id
 720
 721 #define NOCPU           (-1)    /* For when we aren't on a CPU. */
 722 #define NOCPU_OLD       (255)
 723 #define MAXCPU_OLD      (254)
 724
 725 #define PROC_SLOCK(p)   mtx_lock_spin(&(p)->p_slock)
 726 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
 727 #define PROC_SLOCK_ASSERT(p, type)      mtx_assert(&(p)->p_slock, (type))
 728
 729 #define PROC_STATLOCK(p)        mtx_lock_spin(&(p)->p_statmtx)
 730 #define PROC_STATUNLOCK(p)      mtx_unlock_spin(&(p)->p_statmtx)
 731 #define PROC_STATLOCK_ASSERT(p, type)   mtx_assert(&(p)->p_statmtx, (type))
 732
 733 #define PROC_ITIMLOCK(p)        mtx_lock_spin(&(p)->p_itimmtx)
 734 #define PROC_ITIMUNLOCK(p)      mtx_unlock_spin(&(p)->p_itimmtx)
 735 #define PROC_ITIMLOCK_ASSERT(p, type)   mtx_assert(&(p)->p_itimmtx, (type))
 736
 737 #define PROC_PROFLOCK(p)        mtx_lock_spin(&(p)->p_profmtx)
 738 #define PROC_PROFUNLOCK(p)      mtx_unlock_spin(&(p)->p_profmtx)
 739 #define PROC_PROFLOCK_ASSERT(p, type)   mtx_assert(&(p)->p_profmtx, (type))
 740
 741 /* These flags are kept in p_flag. */
 742 #define P_ADVLOCK       0x00000001      /* Process may hold a POSIX advisory
 743                                            lock. */
 744 #define P_CONTROLT      0x00000002      /* Has a controlling terminal. */
 745 #define P_KPROC         0x00000004      /* Kernel process. */
 746 #define P_UNUSED3       0x00000008      /* --available-- */
 747 #define P_PPWAIT        0x00000010      /* Parent is waiting for child to
 748                                            exec/exit. */
 749 #define P_PROFIL        0x00000020      /* Has started profiling. */
 750 #define P_STOPPROF      0x00000040      /* Has thread requesting to stop
 751                                            profiling. */
 752 #define P_HADTHREADS    0x00000080      /* Has had threads (no cleanup
 753                                            shortcuts) */
 754 #define P_SUGID         0x00000100      /* Had set id privileges since last
 755                                            exec. */
 756 #define P_SYSTEM        0x00000200      /* System proc: no sigs, stats or
 757                                            swapping. */
 758 #define P_SINGLE_EXIT   0x00000400      /* Threads suspending should exit,
 759                                            not wait. */
 760 #define P_TRACED        0x00000800      /* Debugged process being traced. */
 761 #define P_WAITED        0x00001000      /* Someone is waiting for us. */
 762 #define P_WEXIT         0x00002000      /* Working on exiting. */
 763 #define P_EXEC          0x00004000      /* Process called exec. */
 764 #define P_WKILLED       0x00008000      /* Killed, go to kernel/user boundary
 765                                            ASAP. */
 766 #define P_CONTINUED     0x00010000      /* Proc has continued from a stopped
 767                                            state. */
 768 #define P_STOPPED_SIG   0x00020000      /* Stopped due to SIGSTOP/SIGTSTP. */
 769 #define P_STOPPED_TRACE 0x00040000      /* Stopped because of tracing. */
 770 #define P_STOPPED_SINGLE 0x00080000     /* Only 1 thread can continue (not to
 771                                            user). */
 772 #define P_PROTECTED     0x00100000      /* Do not kill on memory overcommit. */
 773 #define P_SIGEVENT      0x00200000      /* Process pending signals changed. */
 774 #define P_SINGLE_BOUNDARY 0x00400000    /* Threads should suspend at user
 775                                            boundary. */
 776 #define P_HWPMC         0x00800000      /* Process is using HWPMCs */
 777 #define P_JAILED        0x01000000      /* Process is in jail. */
 778 #define P_TOTAL_STOP    0x02000000      /* Stopped in stop_all_proc. */
 779 #define P_INEXEC        0x04000000      /* Process is in execve(). */
 780 #define P_STATCHILD     0x08000000      /* Child process stopped or exited. */
 781 #define P_INMEM         0x10000000      /* Loaded into memory. */
 782 #define P_SWAPPINGOUT   0x20000000      /* Process is being swapped out. */
 783 #define P_SWAPPINGIN    0x40000000      /* Process is being swapped in. */
 784 #define P_PPTRACE       0x80000000      /* PT_TRACEME by vforked child. */
 785
 786 #define P_STOPPED       (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
 787 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
 788 #define P_KILLED(p)     ((p)->p_flag & P_WKILLED)
 789
 790 /* These flags are kept in p_flag2. */
 791 #define P2_INHERIT_PROTECTED    0x00000001      /* New children get
 792                                                    P_PROTECTED. */
 793 #define P2_NOTRACE              0x00000002      /* No ptrace(2) attach or
 794                                                    coredumps. */
 795 #define P2_NOTRACE_EXEC         0x00000004      /* Keep P2_NOPTRACE on
 796                                                    exec(2). */
 797 #define P2_AST_SU               0x00000008      /* Handles SU ast for
 798                                                    kthreads. */
 799 #define P2_PTRACE_FSTP          0x00000010      /* SIGSTOP from PT_ATTACH not
 800                                                    yet handled. */
 801 #define P2_TRAPCAP              0x00000020      /* SIGTRAP on ENOTCAPABLE */
 802 #define P2_ASLR_ENABLE          0x00000040      /* Force enable ASLR. */
 803 #define P2_ASLR_DISABLE         0x00000080      /* Force disable ASLR. */
 804 #define P2_ASLR_IGNSTART        0x00000100      /* Enable ASLR to consume sbrk
 805                                                    area. */
 806 #define P2_PROTMAX_ENABLE       0x00000200      /* Force enable implied
 807                                                    PROT_MAX. */
 808 #define P2_PROTMAX_DISABLE      0x00000400      /* Force disable implied
 809                                                    PROT_MAX. */
 810 #define P2_STKGAP_DISABLE       0x00000800      /* Disable stack gap for
 811                                                    MAP_STACK */
 812 #define P2_STKGAP_DISABLE_EXEC  0x00001000      /* Stack gap disabled
 813                                                    after exec */
 814
 815 /* Flags protected by proctree_lock, kept in p_treeflags. */
 816 #define P_TREE_ORPHANED         0x00000001      /* Reparented, on orphan list */
 817 #define P_TREE_FIRST_ORPHAN     0x00000002      /* First element of orphan
 818                                                    list */
 819 #define P_TREE_REAPER           0x00000004      /* Reaper of subtree */
 820 #define P_TREE_GRPEXITED        0x00000008      /* exit1() done with job ctl */
 821
 822 /*
 823  * These were process status values (p_stat), now they are only used in
 824  * legacy conversion code.
 825  */
 826 #define SIDL    1               /* Process being created by fork. */
 827 #define SRUN    2               /* Currently runnable. */
 828 #define SSLEEP  3               /* Sleeping on an address. */
 829 #define SSTOP   4               /* Process debugging or suspension. */
 830 #define SZOMB   5               /* Awaiting collection by parent. */
 831 #define SWAIT   6               /* Waiting for interrupt. */
 832 #define SLOCK   7               /* Blocked on a lock. */
 833
 834 #define P_MAGIC         0xbeefface
 835
 836 #ifdef _KERNEL
 837
 838 /* Types and flags for mi_switch(). */
 839 #define SW_TYPE_MASK            0xff    /* First 8 bits are switch type */
 840 #define SWT_NONE                0       /* Unspecified switch. */
 841 #define SWT_PREEMPT             1       /* Switching due to preemption. */
 842 #define SWT_OWEPREEMPT          2       /* Switching due to owepreempt. */
 843 #define SWT_TURNSTILE           3       /* Turnstile contention. */
 844 #define SWT_SLEEPQ              4       /* Sleepq wait. */
 845 #define SWT_SLEEPQTIMO          5       /* Sleepq timeout wait. */
 846 #define SWT_RELINQUISH          6       /* yield call. */
 847 #define SWT_NEEDRESCHED         7       /* NEEDRESCHED was set. */
 848 #define SWT_IDLE                8       /* Switching from the idle thread. */
 849 #define SWT_IWAIT               9       /* Waiting for interrupts. */
 850 #define SWT_SUSPEND             10      /* Thread suspended. */
 851 #define SWT_REMOTEPREEMPT       11      /* Remote processor preempted. */
 852 #define SWT_REMOTEWAKEIDLE      12      /* Remote processor preempted idle. */
 853 #define SWT_COUNT               13      /* Number of switch types. */
 854 /* Flags */
 855 #define SW_VOL          0x0100          /* Voluntary switch. */
 856 #define SW_INVOL        0x0200          /* Involuntary switch. */
 857 #define SW_PREEMPT      0x0400          /* The invol switch is a preemption */
 858
 859 /* How values for thread_single(). */
 860 #define SINGLE_NO_EXIT  0
 861 #define SINGLE_EXIT     1
 862 #define SINGLE_BOUNDARY 2
 863 #define SINGLE_ALLPROC  3
 864
 865 #ifdef MALLOC_DECLARE
 866 MALLOC_DECLARE(M_PARGS);
 867 MALLOC_DECLARE(M_PGRP);
 868 MALLOC_DECLARE(M_SESSION);
 869 MALLOC_DECLARE(M_SUBPROC);
 870 #endif
 871
 872 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
 873         LIST_FOREACH((p), &allproc, p_list)
 874 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
 875         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
 876
 877 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
 878
 879 /*
 880  * We use process IDs <= pid_max <= PID_MAX; PID_MAX + 1 must also fit
 881  * in a pid_t, as it is used to represent "no process group".
 882  */
 883 #define PID_MAX         99999
 884 #define NO_PID          100000
 885 #define THREAD0_TID     NO_PID
 886 extern pid_t pid_max;
 887
 888 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
 889
 890 /* Lock and unlock a process. */
 891 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
 892 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
 893 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
 894 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
 895 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
 896
 897 /* Lock and unlock a process group. */
 898 #define PGRP_LOCK(pg)   mtx_lock(&(pg)->pg_mtx)
 899 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
 900 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
 901 #define PGRP_LOCK_ASSERT(pg, type)      mtx_assert(&(pg)->pg_mtx, (type))
 902
 903 #define PGRP_LOCK_PGSIGNAL(pg) do {                                     \
 904         if ((pg) != NULL)                                               \
 905                 PGRP_LOCK(pg);                                          \
 906 } while (0)
 907 #define PGRP_UNLOCK_PGSIGNAL(pg) do {                                   \
 908         if ((pg) != NULL)                                               \
 909                 PGRP_UNLOCK(pg);                                        \
 910 } while (0)
 911
 912 /* Lock and unlock a session. */
 913 #define SESS_LOCK(s)    mtx_lock(&(s)->s_mtx)
 914 #define SESS_UNLOCK(s)  mtx_unlock(&(s)->s_mtx)
 915 #define SESS_LOCKED(s)  mtx_owned(&(s)->s_mtx)
 916 #define SESS_LOCK_ASSERT(s, type)       mtx_assert(&(s)->s_mtx, (type))
 917
 918 /*
 919  * Non-zero p_lock ensures that:
 920  * - exit1() is not performed until p_lock reaches zero;
 921  * - the process' threads stack are not swapped out if they are currently
 922  *   not (P_INMEM).
 923  *
 924  * PHOLD() asserts that the process (except the current process) is
 925  * not exiting, increments p_lock and swaps threads stacks into memory,
 926  * if needed.
 927  * _PHOLD() is same as PHOLD(), it takes the process locked.
 928  * _PHOLD_LITE() also takes the process locked, but comparing with
 929  * _PHOLD(), it only guarantees that exit1() is not executed,
 930  * faultin() is not called.
 931  */
 932 #define PHOLD(p) do {                                                   \
 933         PROC_LOCK(p);                                                   \
 934         _PHOLD(p);                                                      \
 935         PROC_UNLOCK(p);                                                 \
 936 } while (0)
 937 #define _PHOLD(p) do {                                                  \
 938         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 939         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
 940             ("PHOLD of exiting process %p", p));                        \
 941         (p)->p_lock++;                                                  \
 942         if (((p)->p_flag & P_INMEM) == 0)                               \
 943                 faultin((p));                                           \
 944 } while (0)
 945 #define _PHOLD_LITE(p) do {                                             \
 946         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 947         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
 948             ("PHOLD of exiting process %p", p));                        \
 949         (p)->p_lock++;                                                  \
 950 } while (0)
 951 #define PROC_ASSERT_HELD(p) do {                                        \
 952         KASSERT((p)->p_lock > 0, ("process %p not held", p));           \
 953 } while (0)
 954
 955 #define PRELE(p) do {                                                   \
 956         PROC_LOCK((p));                                                 \
 957         _PRELE((p));                                                    \
 958         PROC_UNLOCK((p));                                               \
 959 } while (0)
 960 #define _PRELE(p) do {                                                  \
 961         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 962         PROC_ASSERT_HELD(p);                                            \
 963         (--(p)->p_lock);                                                \
 964         if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0)                \
 965                 wakeup(&(p)->p_lock);                                   \
 966 } while (0)
 967 #define PROC_ASSERT_NOT_HELD(p) do {                                    \
 968         KASSERT((p)->p_lock == 0, ("process %p held", p));              \
 969 } while (0)
 970
 971 #define PROC_UPDATE_COW(p) do {                                         \
 972         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 973         (p)->p_cowgen++;                                                \
 974 } while (0)
 975
 976 /* Check whether a thread is safe to be swapped out. */
 977 #define thread_safetoswapout(td)        ((td)->td_flags & TDF_CANSWAP)
 978
 979 /* Control whether or not it is safe for curthread to sleep. */
 980 #define THREAD_NO_SLEEPING()            do {                            \
 981         curthread->td_no_sleeping++;                                    \
 982         MPASS(curthread->td_no_sleeping > 0);                           \
 983 } while (0)
 984
 985 #define THREAD_SLEEPING_OK()            do {                            \
 986         MPASS(curthread->td_no_sleeping > 0);                           \
 987         curthread->td_no_sleeping--;                                    \
 988 } while (0)
 989
 990 #define THREAD_CAN_SLEEP()              ((curthread)->td_no_sleeping == 0)
 991
 992 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
 993 #define PIDHASHLOCK(pid) (&pidhashtbl_lock[((pid) & pidhashlock)])
 994 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
 995 extern struct sx *pidhashtbl_lock;
 996 extern u_long pidhash;
 997 extern u_long pidhashlock;
 998
 999 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
1000 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
1001 extern u_long pgrphash;
1002
1003 extern struct sx allproc_lock;
1004 extern int allproc_gen;
1005 extern struct sx proctree_lock;
1006 extern struct mtx ppeers_lock;
1007 extern struct mtx procid_lock;
1008 extern struct proc proc0;               /* Process slot for swapper. */
1009 extern struct thread0_storage thread0_st;       /* Primary thread in proc0. */
1010 #define thread0 (thread0_st.t0st_thread)
1011 extern struct vmspace vmspace0;         /* VM space for proc0. */
1012 extern int hogticks;                    /* Limit on kernel cpu hogs. */
1013 extern int lastpid;
1014 extern int nprocs, maxproc;             /* Current and max number of procs. */
1015 extern int maxprocperuid;               /* Max procs per uid. */
1016 extern u_long ps_arg_cache_limit;
1017
1018 LIST_HEAD(proclist, proc);
1019 TAILQ_HEAD(procqueue, proc);
1020 TAILQ_HEAD(threadqueue, thread);
1021 extern struct proclist allproc;         /* List of all processes. */
1022 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
1023
1024 extern struct uma_zone *proc_zone;
1025
1026 struct  proc *pfind(pid_t);             /* Find process by id. */
1027 struct  proc *pfind_any(pid_t);         /* Find (zombie) process by id. */
1028 struct  proc *pfind_any_locked(pid_t pid); /* Find process by id, locked. */
1029 struct  pgrp *pgfind(pid_t);            /* Find process group by id. */
1030 void    pidhash_slockall(void);         /* Shared lock all pid hash lists. */
1031 void    pidhash_sunlockall(void);       /* Shared unlock all pid hash lists. */
1032
1033 struct  fork_req {
1034         int             fr_flags;
1035         int             fr_pages;
1036         int             *fr_pidp;
1037         struct proc     **fr_procp;
1038         int             *fr_pd_fd;
1039         int             fr_pd_flags;
1040         struct filecaps *fr_pd_fcaps;
1041         int             fr_flags2;
1042 #define FR2_DROPSIG_CAUGHT      0x00000001 /* Drop caught non-DFL signals */
1043 #define FR2_SHARE_PATHS         0x00000002 /* Invert sense of RFFDG for paths */
1044 };
1045
1046 /*
1047  * pget() flags.
1048  */
1049 #define PGET_HOLD       0x00001 /* Hold the process. */
1050 #define PGET_CANSEE     0x00002 /* Check against p_cansee(). */
1051 #define PGET_CANDEBUG   0x00004 /* Check against p_candebug(). */
1052 #define PGET_ISCURRENT  0x00008 /* Check that the found process is current. */
1053 #define PGET_NOTWEXIT   0x00010 /* Check that the process is not in P_WEXIT. */
1054 #define PGET_NOTINEXEC  0x00020 /* Check that the process is not in P_INEXEC. */
1055 #define PGET_NOTID      0x00040 /* Do not assume tid if pid > PID_MAX. */
1056
1057 #define PGET_WANTREAD   (PGET_HOLD | PGET_CANDEBUG | PGET_NOTWEXIT)
1058
1059 int     pget(pid_t pid, int flags, struct proc **pp);
1060
1061 void    ast(struct trapframe *framep);
1062 struct  thread *choosethread(void);
1063 int     cr_cansee(struct ucred *u1, struct ucred *u2);
1064 int     cr_canseesocket(struct ucred *cred, struct socket *so);
1065 int     cr_canseeothergids(struct ucred *u1, struct ucred *u2);
1066 int     cr_canseeotheruids(struct ucred *u1, struct ucred *u2);
1067 int     cr_canseejailproc(struct ucred *u1, struct ucred *u2);
1068 int     cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
1069 int     enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
1070             struct session *sess);
1071 int     enterthispgrp(struct proc *p, struct pgrp *pgrp);
1072 void    faultin(struct proc *p);
1073 int     fork1(struct thread *, struct fork_req *);
1074 void    fork_rfppwait(struct thread *);
1075 void    fork_exit(void (*)(void *, struct trapframe *), void *,
1076             struct trapframe *);
1077 void    fork_return(struct thread *, struct trapframe *);
1078 int     inferior(struct proc *p);
1079 void    kern_proc_vmmap_resident(struct vm_map *map, struct vm_map_entry *entry,
1080             int *resident_count, bool *super);
1081 void    kern_yield(int);
1082 void    kick_proc0(void);
1083 void    killjobc(void);
1084 int     leavepgrp(struct proc *p);
1085 int     maybe_preempt(struct thread *td);
1086 void    maybe_yield(void);
1087 void    mi_switch(int flags);
1088 int     p_candebug(struct thread *td, struct proc *p);
1089 int     p_cansee(struct thread *td, struct proc *p);
1090 int     p_cansched(struct thread *td, struct proc *p);
1091 int     p_cansignal(struct thread *td, struct proc *p, int signum);
1092 int     p_canwait(struct thread *td, struct proc *p);
1093 struct  pargs *pargs_alloc(int len);
1094 void    pargs_drop(struct pargs *pa);
1095 void    pargs_hold(struct pargs *pa);
1096 int     proc_getargv(struct thread *td, struct proc *p, struct sbuf *sb);
1097 int     proc_getauxv(struct thread *td, struct proc *p, struct sbuf *sb);
1098 int     proc_getenvv(struct thread *td, struct proc *p, struct sbuf *sb);
1099 void    procinit(void);
1100 int     proc_iterate(int (*cb)(struct proc *, void *), void *cbarg);
1101 void    proc_linkup0(struct proc *p, struct thread *td);
1102 void    proc_linkup(struct proc *p, struct thread *td);
1103 struct proc *proc_realparent(struct proc *child);
1104 void    proc_reap(struct thread *td, struct proc *p, int *status, int options);
1105 void    proc_reparent(struct proc *child, struct proc *newparent, bool set_oppid);
1106 void    proc_add_orphan(struct proc *child, struct proc *parent);
1107 void    proc_set_traced(struct proc *p, bool stop);
1108 void    proc_wkilled(struct proc *p);
1109 struct  pstats *pstats_alloc(void);
1110 void    pstats_fork(struct pstats *src, struct pstats *dst);
1111 void    pstats_free(struct pstats *ps);
1112 void    proc_clear_orphan(struct proc *p);
1113 void    reaper_abandon_children(struct proc *p, bool exiting);
1114 int     securelevel_ge(struct ucred *cr, int level);
1115 int     securelevel_gt(struct ucred *cr, int level);
1116 void    sess_hold(struct session *);
1117 void    sess_release(struct session *);
1118 int     setrunnable(struct thread *, int);
1119 void    setsugid(struct proc *p);
1120 int     should_yield(void);
1121 int     sigonstack(size_t sp);
1122 void    stopevent(struct proc *, u_int, u_int);
1123 struct  thread *tdfind(lwpid_t, pid_t);
1124 void    threadinit(void);
1125 void    tidhash_add(struct thread *);
1126 void    tidhash_remove(struct thread *);
1127 void    cpu_idle(int);
1128 int     cpu_idle_wakeup(int);
1129 extern  void (*cpu_idle_hook)(sbintime_t);      /* Hook to machdep CPU idler. */
1130 void    cpu_switch(struct thread *, struct thread *, struct mtx *);
1131 void    cpu_throw(struct thread *, struct thread *) __dead2;
1132 void    unsleep(struct thread *);
1133 void    userret(struct thread *, struct trapframe *);
1134
1135 void    cpu_exit(struct thread *);
1136 void    exit1(struct thread *, int, int) __dead2;
1137 void    cpu_copy_thread(struct thread *td, struct thread *td0);
1138 bool    cpu_exec_vmspace_reuse(struct proc *p, struct vm_map *map);
1139 int     cpu_fetch_syscall_args(struct thread *td);
1140 void    cpu_fork(struct thread *, struct proc *, struct thread *, int);
1141 void    cpu_fork_kthread_handler(struct thread *, void (*)(void *), void *);
1142 int     cpu_procctl(struct thread *td, int idtype, id_t id, int com,
1143             void *data);
1144 void    cpu_set_syscall_retval(struct thread *, int);
1145 void    cpu_set_upcall(struct thread *, void (*)(void *), void *,
1146             stack_t *);
1147 int     cpu_set_user_tls(struct thread *, void *tls_base);
1148 void    cpu_thread_alloc(struct thread *);
1149 void    cpu_thread_clean(struct thread *);
1150 void    cpu_thread_exit(struct thread *);
1151 void    cpu_thread_free(struct thread *);
1152 void    cpu_thread_swapin(struct thread *);
1153 void    cpu_thread_swapout(struct thread *);
1154 struct  thread *thread_alloc(int pages);
1155 int     thread_alloc_stack(struct thread *, int pages);
1156 int     thread_check_susp(struct thread *td, bool sleep);
1157 void    thread_cow_get_proc(struct thread *newtd, struct proc *p);
1158 void    thread_cow_get(struct thread *newtd, struct thread *td);
1159 void    thread_cow_free(struct thread *td);
1160 void    thread_cow_update(struct thread *td);
1161 int     thread_create(struct thread *td, struct rtprio *rtp,
1162             int (*initialize_thread)(struct thread *, void *), void *thunk);
1163 void    thread_exit(void) __dead2;
1164 void    thread_free(struct thread *td);
1165 void    thread_link(struct thread *td, struct proc *p);
1166 int     thread_single(struct proc *p, int how);
1167 void    thread_single_end(struct proc *p, int how);
1168 void    thread_stash(struct thread *td);
1169 void    thread_stopped(struct proc *p);
1170 void    childproc_stopped(struct proc *child, int reason);
1171 void    childproc_continued(struct proc *child);
1172 void    childproc_exited(struct proc *child);
1173 int     thread_suspend_check(int how);
1174 bool    thread_suspend_check_needed(void);
1175 void    thread_suspend_switch(struct thread *, struct proc *p);
1176 void    thread_suspend_one(struct thread *td);
1177 void    thread_unlink(struct thread *td);
1178 void    thread_unsuspend(struct proc *p);
1179 void    thread_wait(struct proc *p);
1180
1181 void    stop_all_proc(void);
1182 void    resume_all_proc(void);
1183
1184 static __inline int
1185 curthread_pflags_set(int flags)
1186 {
1187         struct thread *td;
1188         int save;
1189
1190         td = curthread;
1191         save = ~flags | (td->td_pflags & flags);
1192         td->td_pflags |= flags;
1193         return (save);
1194 }
1195
1196 static __inline void
1197 curthread_pflags_restore(int save)
1198 {
1199
1200         curthread->td_pflags &= save;
1201 }
1202
1203 static __inline int
1204 curthread_pflags2_set(int flags)
1205 {
1206         struct thread *td;
1207         int save;
1208
1209         td = curthread;
1210         save = ~flags | (td->td_pflags2 & flags);
1211         td->td_pflags2 |= flags;
1212         return (save);
1213 }
1214
1215 static __inline void
1216 curthread_pflags2_restore(int save)
1217 {
1218
1219         curthread->td_pflags2 &= save;
1220 }
1221
1222 static __inline bool
1223 kstack_contains(struct thread *td, vm_offset_t va, size_t len)
1224 {
1225         return (va >= td->td_kstack && va + len >= va &&
1226             va + len <= td->td_kstack + td->td_kstack_pages * PAGE_SIZE);
1227 }
1228
1229 static __inline __pure2 struct td_sched *
1230 td_get_sched(struct thread *td)
1231 {
1232
1233         return ((struct td_sched *)&td[1]);
1234 }
1235
1236 extern void (*softdep_ast_cleanup)(struct thread *);
1237 static __inline void
1238 td_softdep_cleanup(struct thread *td)
1239 {
1240
1241         if (td->td_su != NULL && softdep_ast_cleanup != NULL)
1242                 softdep_ast_cleanup(td);
1243 }
1244
1245 #define PROC_ID_PID     0
1246 #define PROC_ID_GROUP   1
1247 #define PROC_ID_SESSION 2
1248 #define PROC_ID_REAP    3
1249
1250 void    proc_id_set(int type, pid_t id);
1251 void    proc_id_set_cond(int type, pid_t id);
1252 void    proc_id_clear(int type, pid_t id);
1253
1254 EVENTHANDLER_LIST_DECLARE(process_ctor);
1255 EVENTHANDLER_LIST_DECLARE(process_dtor);
1256 EVENTHANDLER_LIST_DECLARE(process_init);
1257 EVENTHANDLER_LIST_DECLARE(process_fini);
1258 EVENTHANDLER_LIST_DECLARE(process_exit);
1259 EVENTHANDLER_LIST_DECLARE(process_fork);
1260 EVENTHANDLER_LIST_DECLARE(process_exec);
1261
1262 EVENTHANDLER_LIST_DECLARE(thread_ctor);
1263 EVENTHANDLER_LIST_DECLARE(thread_dtor);
1264 EVENTHANDLER_LIST_DECLARE(thread_init);
1265
1266 #endif  /* _KERNEL */
1267
1268 #endif  /* !_SYS_PROC_H_ */