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