sys/sys/proc.h

   1 /*-
   2  * Copyright (c) 1986, 1989, 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)proc.h      8.15 (Berkeley) 5/19/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _SYS_PROC_H_
  39 #define _SYS_PROC_H_
  40
  41 #include <sys/callout.h>                /* For struct callout. */
  42 #include <sys/event.h>                  /* For struct klist. */
  43 #ifndef _KERNEL
  44 #include <sys/filedesc.h>
  45 #endif
  46 #include <sys/queue.h>
  47 #include <sys/_lock.h>
  48 #include <sys/lock_profile.h>
  49 #include <sys/_mutex.h>
  50 #include <sys/priority.h>
  51 #include <sys/rtprio.h>                 /* XXX. */
  52 #include <sys/runq.h>
  53 #include <sys/resource.h>
  54 #include <sys/sigio.h>
  55 #include <sys/signal.h>
  56 #include <sys/signalvar.h>
  57 #ifndef _KERNEL
  58 #include <sys/time.h>                   /* For structs itimerval, timeval. */
  59 #else
  60 #include <sys/pcpu.h>
  61 #endif
  62 #include <sys/ucontext.h>
  63 #include <sys/ucred.h>
  64 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
  65
  66 /*
  67  * One structure allocated per session.
  68  *
  69  * List of locks
  70  * (m)          locked by s_mtx mtx
  71  * (e)          locked by proctree_lock sx
  72  * (c)          const until freeing
  73  */
  74 struct session {
  75         int             s_count;        /* (m) Ref cnt; pgrps in session. */
  76         struct proc     *s_leader;      /* (m + e) Session leader. */
  77         struct vnode    *s_ttyvp;       /* (m) Vnode of controlling tty. */
  78         struct tty      *s_ttyp;        /* (m) Controlling tty. */
  79         pid_t           s_sid;          /* (c) Session ID. */
  80                                         /* (m) Setlogin() name: */
  81         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
  82         struct mtx      s_mtx;          /* Mutex to protect members. */
  83 };
  84
  85 /*
  86  * One structure allocated per process group.
  87  *
  88  * List of locks
  89  * (m)          locked by pg_mtx mtx
  90  * (e)          locked by proctree_lock sx
  91  * (c)          const until freeing
  92  */
  93 struct pgrp {
  94         LIST_ENTRY(pgrp) pg_hash;       /* (e) Hash chain. */
  95         LIST_HEAD(, proc) pg_members;   /* (m + e) Pointer to pgrp members. */
  96         struct session  *pg_session;    /* (c) Pointer to session. */
  97         struct sigiolst pg_sigiolst;    /* (m) List of sigio sources. */
  98         pid_t           pg_id;          /* (c) Process group id. */
  99         int             pg_jobc;        /* (m) Job control process count. */
 100         struct mtx      pg_mtx;         /* Mutex to protect members */
 101 };
 102
 103 /*
 104  * pargs, used to hold a copy of the command line, if it had a sane length.
 105  */
 106 struct pargs {
 107         u_int   ar_ref;         /* Reference count. */
 108         u_int   ar_length;      /* Length. */
 109         u_char  ar_args[1];     /* Arguments. */
 110 };
 111
 112 /*-
 113  * Description of a process.
 114  *
 115  * This structure contains the information needed to manage a thread of
 116  * control, known in UN*X as a process; it has references to substructures
 117  * containing descriptions of things that the process uses, but may share
 118  * with related processes.  The process structure and the substructures
 119  * are always addressable except for those marked "(CPU)" below,
 120  * which might be addressable only on a processor on which the process
 121  * is running.
 122  *
 123  * Below is a key of locks used to protect each member of struct proc.  The
 124  * lock is indicated by a reference to a specific character in parens in the
 125  * associated comment.
 126  *      * - not yet protected
 127  *      a - only touched by curproc or parent during fork/wait
 128  *      b - created at fork, never changes
 129  *              (exception aiods switch vmspaces, but they are also
 130  *              marked 'P_SYSTEM' so hopefully it will be left alone)
 131  *      c - locked by proc mtx
 132  *      d - locked by allproc_lock lock
 133  *      e - locked by proctree_lock lock
 134  *      f - session mtx
 135  *      g - process group mtx
 136  *      h - callout_lock mtx
 137  *      i - by curproc or the master session mtx
 138  *      j - locked by proc slock
 139  *      k - only accessed by curthread
 140  *      k*- only accessed by curthread and from an interrupt
 141  *      l - the attaching proc or attaching proc parent
 142  *      m - Giant
 143  *      n - not locked, lazy
 144  *      o - ktrace lock
 145  *      q - td_contested lock
 146  *      r - p_peers lock
 147  *      t - thread lock
 148  *      x - created at fork, only changes during single threading in exec
 149  *      z - zombie threads lock
 150  *
 151  * If the locking key specifies two identifiers (for example, p_pptr) then
 152  * either lock is sufficient for read access, but both locks must be held
 153  * for write access.
 154  */
 155 struct kaudit_record;
 156 struct td_sched;
 157 struct nlminfo;
 158 struct kaioinfo;
 159 struct p_sched;
 160 struct proc;
 161 struct sleepqueue;
 162 struct thread;
 163 struct trapframe;
 164 struct turnstile;
 165 struct mqueue_notifier;
 166 struct cpuset;
 167
 168 /*
 169  * Kernel runnable context (thread).
 170  * This is what is put to sleep and reactivated.
 171  * Thread context.  Processes may have multiple threads.
 172  */
 173 struct thread {
 174         struct mtx      *volatile td_lock; /* replaces sched lock */
 175         struct proc     *td_proc;       /* (*) Associated process. */
 176         TAILQ_ENTRY(thread) td_plist;   /* (*) All threads in this proc. */
 177         TAILQ_ENTRY(thread) td_runq;    /* (t) Run queue. */
 178         TAILQ_ENTRY(thread) td_slpq;    /* (t) Sleep queue. */
 179         TAILQ_ENTRY(thread) td_lockq;   /* (t) Lock queue. */
 180         struct cpuset   *td_cpuset;     /* (t) CPU affinity mask. */
 181         struct seltd    *td_sel;        /* Select queue/channel. */
 182         struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
 183         struct turnstile *td_turnstile; /* (k) Associated turnstile. */
 184         struct umtx_q   *td_umtxq;      /* (c?) Link for when we're blocked. */
 185         lwpid_t         td_tid;         /* (b) Thread ID. */
 186         sigqueue_t      td_sigqueue;    /* (c) Sigs arrived, not delivered. */
 187 #define td_siglist      td_sigqueue.sq_signals
 188
 189 /* Cleared during fork1() */
 190 #define td_startzero td_flags
 191         int             td_flags;       /* (t) TDF_* flags. */
 192         int             td_inhibitors;  /* (t) Why can not run. */
 193         int             td_pflags;      /* (k) Private thread (TDP_*) flags. */
 194         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
 195         int             td_sqqueue;     /* (t) Sleepqueue queue blocked on. */
 196         void            *td_wchan;      /* (t) Sleep address. */
 197         const char      *td_wmesg;      /* (t) Reason for sleep. */
 198         u_char          td_lastcpu;     /* (t) Last cpu we were on. */
 199         u_char          td_oncpu;       /* (t) Which cpu we are on. */
 200         volatile u_char td_owepreempt;  /* (k*) Preempt on last critical_exit */
 201         u_char          td_tsqueue;     /* (t) Turnstile queue blocked on. */
 202         short           td_locks;       /* (k) Count of non-spin locks. */
 203         short           td_rw_rlocks;   /* (k) count of rwlock read locks. */
 204         struct turnstile *td_blocked;   /* (t) Lock thread is blocked on. */
 205         const char      *td_lockname;   /* (t) Name of lock blocked on. */
 206         LIST_HEAD(, turnstile) td_contested;    /* (q) Contested locks. */
 207         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
 208         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
 209         int             td_pinned;      /* (k) Temporary cpu pin count. */
 210         struct ucred    *td_ucred;      /* (k) Reference to credentials. */
 211         u_int           td_estcpu;      /* (t) estimated cpu utilization */
 212         u_int           td_slptick;     /* (t) Time at sleep. */
 213         struct rusage   td_ru;          /* (t) rusage information */
 214         uint64_t        td_incruntime;  /* (t) Cpu ticks to transfer to proc. */
 215         uint64_t        td_runtime;     /* (t) How many cpu ticks we've run. */
 216         u_int           td_pticks;      /* (t) Statclock hits for profiling */
 217         u_int           td_sticks;      /* (t) Statclock hits in system mode. */
 218         u_int           td_iticks;      /* (t) Statclock hits in intr mode. */
 219         u_int           td_uticks;      /* (t) Statclock hits in user mode. */
 220         u_int           td_uuticks;     /* (k) Statclock hits (usr), for UTS. */
 221         u_int           td_usticks;     /* (k) Statclock hits (sys), for UTS. */
 222         int             td_intrval;     /* (t) Return value for sleepq. */
 223         sigset_t        td_oldsigmask;  /* (k) Saved mask from pre sigpause. */
 224         sigset_t        td_sigmask;     /* (c) Current signal mask. */
 225         volatile u_int  td_generation;  /* (k) For detection of preemption */
 226         stack_t         td_sigstk;      /* (k) Stack ptr and on-stack flag. */
 227         int             td_xsig;        /* (c) Signal for ptrace */
 228         u_long          td_profil_addr; /* (k) Temporary addr until AST. */
 229         u_int           td_profil_ticks; /* (k) Temporary ticks until AST. */
 230         char            td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
 231 #define td_endzero td_base_pri
 232
 233 /* Copied during fork1() or thread_sched_upcall(). */
 234 #define td_startcopy td_endzero
 235         u_char          td_rqindex;     /* (t) Run queue index. */
 236         u_char          td_base_pri;    /* (t) Thread base kernel priority. */
 237         u_char          td_priority;    /* (t) Thread active priority. */
 238         u_char          td_pri_class;   /* (t) Scheduling class. */
 239         u_char          td_user_pri;    /* (t) User pri from estcpu and nice. */
 240         u_char          td_base_user_pri; /* (t) Base user pri */
 241 #define td_endcopy td_pcb
 242
 243 /*
 244  * Fields that must be manually set in fork1() or thread_sched_upcall()
 245  * or already have been set in the allocator, constructor, etc.
 246  */
 247         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
 248         enum {
 249                 TDS_INACTIVE = 0x0,
 250                 TDS_INHIBITED,
 251                 TDS_CAN_RUN,
 252                 TDS_RUNQ,
 253                 TDS_RUNNING
 254         } td_state;                     /* (t) thread state */
 255         register_t      td_retval[2];   /* (k) Syscall aux returns. */
 256         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
 257         struct trapframe *td_frame;     /* (k) */
 258         struct vm_object *td_kstack_obj;/* (a) Kstack object. */
 259         vm_offset_t     td_kstack;      /* (a) Kernel VA of kstack. */
 260         int             td_kstack_pages; /* (a) Size of the kstack. */
 261         struct vm_object *td_altkstack_obj;/* (a) Alternate kstack object. */
 262         vm_offset_t     td_altkstack;   /* (a) Kernel VA of alternate kstack. */
 263         int             td_altkstack_pages; /* (a) Size of alternate kstack. */
 264         volatile u_int  td_critnest;    /* (k*) Critical section nest level. */
 265         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
 266         struct td_sched *td_sched;      /* (*) Scheduler-specific data. */
 267         struct kaudit_record    *td_ar; /* (k) Active audit record, if any. */
 268         int             td_syscalls;    /* per-thread syscall count (used by NFS :)) */
 269         struct lpohead  td_lprof[2];    /* (a) lock profiling objects. */
 270 };
 271
 272 struct mtx *thread_lock_block(struct thread *);
 273 void thread_lock_unblock(struct thread *, struct mtx *);
 274 void thread_lock_set(struct thread *, struct mtx *);
 275 #define THREAD_LOCK_ASSERT(td, type)                                    \
 276 do {                                                                    \
 277         struct mtx *__m = (td)->td_lock;                                \
 278         if (__m != &blocked_lock)                                       \
 279                 mtx_assert(__m, (type));                                \
 280 } while (0)
 281
 282 #ifdef INVARIANTS
 283 #define THREAD_LOCKPTR_ASSERT(td, lock)                                 \
 284 do {                                                                    \
 285         struct mtx *__m = (td)->td_lock;                                \
 286         KASSERT((__m == &blocked_lock || __m == (lock)),                \
 287             ("Thread %p lock %p does not match %p", td, __m, (lock)));  \
 288 } while (0)
 289 #else
 290 #define THREAD_LOCKPTR_ASSERT(td, lock)
 291 #endif
 292
 293 /*
 294  * Flags kept in td_flags:
 295  * To change these you MUST have the scheduler lock.
 296  */
 297 #define TDF_BORROWING   0x00000001 /* Thread is borrowing pri from another. */
 298 #define TDF_INPANIC     0x00000002 /* Caused a panic, let it drive crashdump. */
 299 #define TDF_INMEM       0x00000004 /* Thread's stack is in memory. */
 300 #define TDF_SINTR       0x00000008 /* Sleep is interruptible. */
 301 #define TDF_TIMEOUT     0x00000010 /* Timing out during sleep. */
 302 #define TDF_IDLETD      0x00000020 /* This is a per-CPU idle thread. */
 303 #define TDF_CANSWAP     0x00000040 /* Thread can be swapped. */
 304 #define TDF_SLEEPABORT  0x00000080 /* sleepq_abort was called. */
 305 #define TDF_KTH_SUSP    0x00000100 /* kthread is suspended */
 306 #define TDF_UBORROWING  0x00000200 /* Thread is borrowing user pri. */
 307 #define TDF_BOUNDARY    0x00000400 /* Thread suspended at user boundary */
 308 #define TDF_ASTPENDING  0x00000800 /* Thread has some asynchronous events. */
 309 #define TDF_TIMOFAIL    0x00001000 /* Timeout from sleep after we were awake. */
 310 #define TDF_UNUSED2000  0x00002000 /* --available-- */
 311 #define TDF_UPIBLOCKED  0x00004000 /* Thread blocked on user PI mutex. */
 312 #define TDF_NEEDSUSPCHK 0x00008000 /* Thread may need to suspend. */
 313 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
 314 #define TDF_NEEDSIGCHK  0x00020000 /* Thread may need signal delivery. */
 315 #define TDF_XSIG        0x00040000 /* Thread is exchanging signal under trace */
 316 #define TDF_UNUSED19    0x00080000 /* Thread is sleeping on a umtx. */
 317 #define TDF_THRWAKEUP   0x00100000 /* Libthr thread must not suspend itself. */
 318 #define TDF_DBSUSPEND   0x00200000 /* Thread is suspended by debugger */
 319 #define TDF_SWAPINREQ   0x00400000 /* Swapin request due to wakeup. */
 320 #define TDF_UNUSED23    0x00800000 /* --available-- */
 321 #define TDF_SCHED0      0x01000000 /* Reserved for scheduler private use */
 322 #define TDF_SCHED1      0x02000000 /* Reserved for scheduler private use */
 323 #define TDF_SCHED2      0x04000000 /* Reserved for scheduler private use */
 324 #define TDF_SCHED3      0x08000000 /* Reserved for scheduler private use */
 325 #define TDF_ALRMPEND    0x10000000 /* Pending SIGVTALRM needs to be posted. */
 326 #define TDF_PROFPEND    0x20000000 /* Pending SIGPROF needs to be posted. */
 327 #define TDF_MACPEND     0x40000000 /* AST-based MAC event pending. */
 328
 329 /*
 330  * "Private" flags kept in td_pflags:
 331  * These are only written by curthread and thus need no locking.
 332  */
 333 #define TDP_OLDMASK     0x00000001 /* Need to restore mask after suspend. */
 334 #define TDP_INKTR       0x00000002 /* Thread is currently in KTR code. */
 335 #define TDP_INKTRACE    0x00000004 /* Thread is currently in KTRACE code. */
 336 #define TDP_UNUSED8     0x00000008 /* available */
 337 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
 338 #define TDP_ALTSTACK    0x00000020 /* Have alternate signal stack. */
 339 #define TDP_DEADLKTREAT 0x00000040 /* Lock aquisition - deadlock treatment. */
 340 #define TDP_UNUSED80    0x00000080 /* available. */
 341 #define TDP_NOSLEEPING  0x00000100 /* Thread is not allowed to sleep on a sq. */
 342 #define TDP_OWEUPC      0x00000200 /* Call addupc() at next AST. */
 343 #define TDP_ITHREAD     0x00000400 /* Thread is an interrupt thread. */
 344 #define TDP_UNUSED800   0x00000800 /* available. */
 345 #define TDP_SCHED1      0x00001000 /* Reserved for scheduler private use */
 346 #define TDP_SCHED2      0x00002000 /* Reserved for scheduler private use */
 347 #define TDP_SCHED3      0x00004000 /* Reserved for scheduler private use */
 348 #define TDP_SCHED4      0x00008000 /* Reserved for scheduler private use */
 349 #define TDP_GEOM        0x00010000 /* Settle GEOM before finishing syscall */
 350 #define TDP_SOFTDEP     0x00020000 /* Stuck processing softdep worklist */
 351 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
 352 #define TDP_WAKEUP      0x00080000 /* Don't sleep in umtx cond_wait */
 353 #define TDP_INBDFLUSH   0x00100000 /* Already in BO_BDFLUSH, do not recurse */
 354 #define TDP_KTHREAD     0x00200000 /* This is an official kernel thread */
 355 #define TDP_CALLCHAIN   0x00400000 /* Capture thread's callchain */
 356
 357 /*
 358  * Reasons that the current thread can not be run yet.
 359  * More than one may apply.
 360  */
 361 #define TDI_SUSPENDED   0x0001  /* On suspension queue. */
 362 #define TDI_SLEEPING    0x0002  /* Actually asleep! (tricky). */
 363 #define TDI_SWAPPED     0x0004  /* Stack not in mem.  Bad juju if run. */
 364 #define TDI_LOCK        0x0008  /* Stopped on a lock. */
 365 #define TDI_IWAIT       0x0010  /* Awaiting interrupt. */
 366
 367 #define TD_IS_SLEEPING(td)      ((td)->td_inhibitors & TDI_SLEEPING)
 368 #define TD_ON_SLEEPQ(td)        ((td)->td_wchan != NULL)
 369 #define TD_IS_SUSPENDED(td)     ((td)->td_inhibitors & TDI_SUSPENDED)
 370 #define TD_IS_SWAPPED(td)       ((td)->td_inhibitors & TDI_SWAPPED)
 371 #define TD_ON_LOCK(td)          ((td)->td_inhibitors & TDI_LOCK)
 372 #define TD_AWAITING_INTR(td)    ((td)->td_inhibitors & TDI_IWAIT)
 373 #define TD_IS_RUNNING(td)       ((td)->td_state == TDS_RUNNING)
 374 #define TD_ON_RUNQ(td)          ((td)->td_state == TDS_RUNQ)
 375 #define TD_CAN_RUN(td)          ((td)->td_state == TDS_CAN_RUN)
 376 #define TD_IS_INHIBITED(td)     ((td)->td_state == TDS_INHIBITED)
 377 #define TD_ON_UPILOCK(td)       ((td)->td_flags & TDF_UPIBLOCKED)
 378 #define TD_IS_IDLETHREAD(td)    ((td)->td_flags & TDF_IDLETD)
 379
 380
 381 #define TD_SET_INHIB(td, inhib) do {                    \
 382         (td)->td_state = TDS_INHIBITED;                 \
 383         (td)->td_inhibitors |= (inhib);                 \
 384 } while (0)
 385
 386 #define TD_CLR_INHIB(td, inhib) do {                    \
 387         if (((td)->td_inhibitors & (inhib)) &&          \
 388             (((td)->td_inhibitors &= ~(inhib)) == 0))   \
 389                 (td)->td_state = TDS_CAN_RUN;           \
 390 } while (0)
 391
 392 #define TD_SET_SLEEPING(td)     TD_SET_INHIB((td), TDI_SLEEPING)
 393 #define TD_SET_SWAPPED(td)      TD_SET_INHIB((td), TDI_SWAPPED)
 394 #define TD_SET_LOCK(td)         TD_SET_INHIB((td), TDI_LOCK)
 395 #define TD_SET_SUSPENDED(td)    TD_SET_INHIB((td), TDI_SUSPENDED)
 396 #define TD_SET_IWAIT(td)        TD_SET_INHIB((td), TDI_IWAIT)
 397 #define TD_SET_EXITING(td)      TD_SET_INHIB((td), TDI_EXITING)
 398
 399 #define TD_CLR_SLEEPING(td)     TD_CLR_INHIB((td), TDI_SLEEPING)
 400 #define TD_CLR_SWAPPED(td)      TD_CLR_INHIB((td), TDI_SWAPPED)
 401 #define TD_CLR_LOCK(td)         TD_CLR_INHIB((td), TDI_LOCK)
 402 #define TD_CLR_SUSPENDED(td)    TD_CLR_INHIB((td), TDI_SUSPENDED)
 403 #define TD_CLR_IWAIT(td)        TD_CLR_INHIB((td), TDI_IWAIT)
 404
 405 #define TD_SET_RUNNING(td)      (td)->td_state = TDS_RUNNING
 406 #define TD_SET_RUNQ(td)         (td)->td_state = TDS_RUNQ
 407 #define TD_SET_CAN_RUN(td)      (td)->td_state = TDS_CAN_RUN
 408
 409 /*
 410  * XXX: Does this belong in resource.h or resourcevar.h instead?
 411  * Resource usage extension.  The times in rusage structs in the kernel are
 412  * never up to date.  The actual times are kept as runtimes and tick counts
 413  * (with control info in the "previous" times), and are converted when
 414  * userland asks for rusage info.  Backwards compatibility prevents putting
 415  * this directly in the user-visible rusage struct.
 416  *
 417  * Locking: (cj) means (j) for p_rux and (c) for p_crux.
 418  */
 419 struct rusage_ext {
 420         u_int64_t       rux_runtime;    /* (cj) Real time. */
 421         u_int64_t       rux_uticks;     /* (cj) Statclock hits in user mode. */
 422         u_int64_t       rux_sticks;     /* (cj) Statclock hits in sys mode. */
 423         u_int64_t       rux_iticks;     /* (cj) Statclock hits in intr mode. */
 424         u_int64_t       rux_uu;         /* (c) Previous user time in usec. */
 425         u_int64_t       rux_su;         /* (c) Previous sys time in usec. */
 426         u_int64_t       rux_tu;         /* (c) Previous total time in usec. */
 427 };
 428
 429 /*
 430  * Process structure.
 431  */
 432 struct proc {
 433         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
 434         TAILQ_HEAD(, thread) p_threads; /* (c) all threads. */
 435         struct mtx      p_slock;        /* process spin lock */
 436         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
 437         struct filedesc *p_fd;          /* (b) Open files. */
 438         struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
 439         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
 440         struct plimit   *p_limit;       /* (c) Process limits. */
 441         struct callout  p_limco;        /* (c) Limit callout handle */
 442         struct sigacts  *p_sigacts;     /* (x) Signal actions, state (CPU). */
 443
 444         /*
 445          * The following don't make too much sense.
 446          * See the td_ or ke_ versions of the same flags.
 447          */
 448         int             p_flag;         /* (c) P_* flags. */
 449         enum {
 450                 PRS_NEW = 0,            /* In creation */
 451                 PRS_NORMAL,             /* threads can be run. */
 452                 PRS_ZOMBIE
 453         } p_state;                      /* (j/c) S* process status. */
 454         pid_t           p_pid;          /* (b) Process identifier. */
 455         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
 456         LIST_ENTRY(proc) p_pglist;      /* (g + e) List of processes in pgrp. */
 457         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
 458         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
 459         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
 460         struct mtx      p_mtx;          /* (n) Lock for this struct. */
 461         struct ksiginfo *p_ksi; /* Locked by parent proc lock */
 462         sigqueue_t      p_sigqueue;     /* (c) Sigs not delivered to a td. */
 463 #define p_siglist       p_sigqueue.sq_signals
 464
 465 /* The following fields are all zeroed upon creation in fork. */
 466 #define p_startzero     p_oppid
 467         pid_t           p_oppid;        /* (c + e) Save ppid in ptrace. XXX */
 468         struct vmspace  *p_vmspace;     /* (b) Address space. */
 469         u_int           p_swtick;       /* (c) Tick when swapped in or out. */
 470         struct itimerval p_realtimer;   /* (c) Alarm timer. */
 471         struct rusage   p_ru;           /* (a) Exit information. */
 472         struct rusage_ext p_rux;        /* (cj) Internal resource usage. */
 473         struct rusage_ext p_crux;       /* (c) Internal child resource usage. */
 474         int             p_profthreads;  /* (c) Num threads in addupc_task. */
 475         volatile int    p_exitthreads;  /* (j) Number of threads exiting */
 476         int             p_traceflag;    /* (o) Kernel trace points. */
 477         struct vnode    *p_tracevp;     /* (c + o) Trace to vnode. */
 478         struct ucred    *p_tracecred;   /* (o) Credentials to trace with. */
 479         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
 480         char            p_lock;         /* (c) Proclock (prevent swap) count. */
 481         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
 482         int             p_sigparent;    /* (c) Signal to parent on exit. */
 483         int             p_sig;          /* (n) For core dump/debugger XXX. */
 484         u_long          p_code;         /* (n) For core dump/debugger XXX. */
 485         u_int           p_stops;        /* (c) Stop event bitmask. */
 486         u_int           p_stype;        /* (c) Stop event type. */
 487         char            p_step;         /* (c) Process is stopped. */
 488         u_char          p_pfsflags;     /* (c) Procfs flags. */
 489         struct nlminfo  *p_nlminfo;     /* (?) Only used by/for lockd. */
 490         struct kaioinfo *p_aioinfo;     /* (c) ASYNC I/O info. */
 491         struct thread   *p_singlethread;/* (c + j) If single threading this is it */
 492         int             p_suspcount;    /* (j) Num threads in suspended mode. */
 493         struct thread   *p_xthread;     /* (c) Trap thread */
 494         int             p_boundary_count;/* (c) Num threads at user boundary */
 495         int             p_pendingcnt;   /* how many signals are pending */
 496         struct itimers  *p_itimers;     /* (c) POSIX interval timers. */
 497 /* End area that is zeroed on creation. */
 498 #define p_endzero       p_magic
 499
 500 /* The following fields are all copied upon creation in fork. */
 501 #define p_startcopy     p_endzero
 502         u_int           p_magic;        /* (b) Magic number. */
 503         int             p_osrel;        /* (x) osreldate for the
 504                                                binary (from ELF note, if any) */
 505         char            p_comm[MAXCOMLEN + 1];  /* (b) Process name. */
 506         struct pgrp     *p_pgrp;        /* (c + e) Pointer to process group. */
 507         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
 508         struct pargs    *p_args;        /* (c) Process arguments. */
 509         rlim_t          p_cpulimit;     /* (c) Current CPU limit in seconds. */
 510         signed char     p_nice;         /* (c) Process "nice" value. */
 511 /* End area that is copied on creation. */
 512 #define p_endcopy       p_xstat
 513
 514         u_short         p_xstat;        /* (c) Exit status; also stop sig. */
 515         struct knlist   p_klist;        /* (c) Knotes attached to this proc. */
 516         int             p_numthreads;   /* (c) Number of threads. */
 517         struct mdproc   p_md;           /* Any machine-dependent fields. */
 518         struct callout  p_itcallout;    /* (h + c) Interval timer callout. */
 519         u_short         p_acflag;       /* (c) Accounting flags. */
 520         struct proc     *p_peers;       /* (r) */
 521         struct proc     *p_leader;      /* (b) */
 522         void            *p_emuldata;    /* (c) Emulator state data. */
 523         struct label    *p_label;       /* (*) Proc (not subject) MAC label. */
 524         struct p_sched  *p_sched;       /* (*) Scheduler-specific data. */
 525         STAILQ_HEAD(, ktr_request)      p_ktr;  /* (o) KTR event queue. */
 526         LIST_HEAD(, mqueue_notifier)    p_mqnotifier; /* (c) mqueue notifiers.*/
 527 };
 528
 529 #define p_session       p_pgrp->pg_session
 530 #define p_pgid          p_pgrp->pg_id
 531
 532 #define NOCPU   0xff            /* For when we aren't on a CPU. */
 533
 534 #define PROC_SLOCK(p)   mtx_lock_spin(&(p)->p_slock)
 535 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
 536 #define PROC_SLOCK_ASSERT(p, type)      mtx_assert(&(p)->p_slock, (type))
 537
 538 /* These flags are kept in p_flag. */
 539 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
 540 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
 541 #define P_KTHREAD       0x00004 /* Kernel thread (*). */
 542 #define P_NOLOAD        0x00008 /* Ignore during load avg calculations. */
 543 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
 544 #define P_PROFIL        0x00020 /* Has started profiling. */
 545 #define P_STOPPROF      0x00040 /* Has thread requesting to stop profiling. */
 546 #define P_HADTHREADS    0x00080 /* Has had threads (no cleanup shortcuts) */
 547 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
 548 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
 549 #define P_SINGLE_EXIT   0x00400 /* Threads suspending should exit, not wait. */
 550 #define P_TRACED        0x00800 /* Debugged process being traced. */
 551 #define P_WAITED        0x01000 /* Someone is waiting for us. */
 552 #define P_WEXIT         0x02000 /* Working on exiting. */
 553 #define P_EXEC          0x04000 /* Process called exec. */
 554 #define P_UNUSED8000    0x08000 /* available. */
 555 #define P_CONTINUED     0x10000 /* Proc has continued from a stopped state. */
 556 #define P_STOPPED_SIG   0x20000 /* Stopped due to SIGSTOP/SIGTSTP. */
 557 #define P_STOPPED_TRACE 0x40000 /* Stopped because of tracing. */
 558 #define P_STOPPED_SINGLE 0x80000 /* Only 1 thread can continue (not to user). */
 559 #define P_PROTECTED     0x100000 /* Do not kill on memory overcommit. */
 560 #define P_SIGEVENT      0x200000 /* Process pending signals changed. */
 561 #define P_SINGLE_BOUNDARY 0x400000 /* Threads should suspend at user boundary. */
 562 #define P_HWPMC         0x800000 /* Process is using HWPMCs */
 563
 564 #define P_JAILED        0x1000000 /* Process is in jail. */
 565 #define P_INEXEC        0x4000000 /* Process is in execve(). */
 566 #define P_STATCHILD     0x8000000 /* Child process stopped or exited. */
 567 #define P_INMEM         0x10000000 /* Loaded into memory. */
 568 #define P_SWAPPINGOUT   0x20000000 /* Process is being swapped out. */
 569 #define P_SWAPPINGIN    0x40000000 /* Process is being swapped in. */
 570
 571 #define P_STOPPED       (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
 572 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
 573
 574 /*
 575  * These were process status values (p_stat), now they are only used in
 576  * legacy conversion code.
 577  */
 578 #define SIDL    1               /* Process being created by fork. */
 579 #define SRUN    2               /* Currently runnable. */
 580 #define SSLEEP  3               /* Sleeping on an address. */
 581 #define SSTOP   4               /* Process debugging or suspension. */
 582 #define SZOMB   5               /* Awaiting collection by parent. */
 583 #define SWAIT   6               /* Waiting for interrupt. */
 584 #define SLOCK   7               /* Blocked on a lock. */
 585
 586 #define P_MAGIC         0xbeefface
 587
 588 #ifdef _KERNEL
 589
 590 /* Flags for mi_switch(). */
 591 #define SW_VOL          0x0001          /* Voluntary switch. */
 592 #define SW_INVOL        0x0002          /* Involuntary switch. */
 593 #define SW_PREEMPT      0x0004          /* The invol switch is a preemption */
 594
 595 /* How values for thread_single(). */
 596 #define SINGLE_NO_EXIT  0
 597 #define SINGLE_EXIT     1
 598 #define SINGLE_BOUNDARY 2
 599
 600 #ifdef MALLOC_DECLARE
 601 MALLOC_DECLARE(M_PARGS);
 602 MALLOC_DECLARE(M_PGRP);
 603 MALLOC_DECLARE(M_SESSION);
 604 MALLOC_DECLARE(M_SUBPROC);
 605 MALLOC_DECLARE(M_ZOMBIE);
 606 #endif
 607
 608 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
 609         LIST_FOREACH((p), &allproc, p_list)
 610 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
 611         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
 612
 613 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
 614
 615 /*
 616  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
 617  * as it is used to represent "no process group".
 618  */
 619 #define PID_MAX         99999
 620 #define NO_PID          100000
 621
 622 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
 623 #define SESSHOLD(s)     ((s)->s_count++)
 624 #define SESSRELE(s)     sessrele(s)
 625
 626
 627 #define STOPEVENT(p, e, v) do {                                         \
 628         if ((p)->p_stops & (e)) {                                       \
 629                 PROC_LOCK(p);                                           \
 630                 stopevent((p), (e), (v));                               \
 631                 PROC_UNLOCK(p);                                         \
 632         }                                                               \
 633 } while (0)
 634 #define _STOPEVENT(p, e, v) do {                                        \
 635         PROC_LOCK_ASSERT(p, MA_OWNED);                                  \
 636         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.lock_object, \
 637             "checking stopevent %d", (e));                              \
 638         if ((p)->p_stops & (e))                                         \
 639                 stopevent((p), (e), (v));                               \
 640 } while (0)
 641
 642 /* Lock and unlock a process. */
 643 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
 644 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
 645 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
 646 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
 647 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
 648
 649 /* Lock and unlock a process group. */
 650 #define PGRP_LOCK(pg)   mtx_lock(&(pg)->pg_mtx)
 651 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
 652 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
 653 #define PGRP_LOCK_ASSERT(pg, type)      mtx_assert(&(pg)->pg_mtx, (type))
 654
 655 #define PGRP_LOCK_PGSIGNAL(pg) do {                                     \
 656         if ((pg) != NULL)                                               \
 657                 PGRP_LOCK(pg);                                          \
 658 } while (0)
 659 #define PGRP_UNLOCK_PGSIGNAL(pg) do {                                   \
 660         if ((pg) != NULL)                                               \
 661                 PGRP_UNLOCK(pg);                                        \
 662 } while (0)
 663
 664 /* Lock and unlock a session. */
 665 #define SESS_LOCK(s)    mtx_lock(&(s)->s_mtx)
 666 #define SESS_UNLOCK(s)  mtx_unlock(&(s)->s_mtx)
 667 #define SESS_LOCKED(s)  mtx_owned(&(s)->s_mtx)
 668 #define SESS_LOCK_ASSERT(s, type)       mtx_assert(&(s)->s_mtx, (type))
 669
 670 /* Hold process U-area in memory, normally for ptrace/procfs work. */
 671 #define PHOLD(p) do {                                                   \
 672         PROC_LOCK(p);                                                   \
 673         _PHOLD(p);                                                      \
 674         PROC_UNLOCK(p);                                                 \
 675 } while (0)
 676 #define _PHOLD(p) do {                                                  \
 677         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 678         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
 679             ("PHOLD of exiting process"));                              \
 680         (p)->p_lock++;                                                  \
 681         if (((p)->p_flag & P_INMEM) == 0)                               \
 682                 faultin((p));                                           \
 683 } while (0)
 684 #define PROC_ASSERT_HELD(p) do {                                        \
 685         KASSERT((p)->p_lock > 0, ("process not held"));                 \
 686 } while (0)
 687
 688 #define PRELE(p) do {                                                   \
 689         PROC_LOCK((p));                                                 \
 690         _PRELE((p));                                                    \
 691         PROC_UNLOCK((p));                                               \
 692 } while (0)
 693 #define _PRELE(p) do {                                                  \
 694         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 695         (--(p)->p_lock);                                                \
 696         if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0)                \
 697                 wakeup(&(p)->p_lock);                                   \
 698 } while (0)
 699 #define PROC_ASSERT_NOT_HELD(p) do {                                    \
 700         KASSERT((p)->p_lock == 0, ("process held"));                    \
 701 } while (0)
 702
 703 /* Check whether a thread is safe to be swapped out. */
 704 #define thread_safetoswapout(td)        ((td)->td_flags & TDF_CANSWAP)
 705
 706 /* Control whether or not it is safe for curthread to sleep. */
 707 #define THREAD_NO_SLEEPING() do {                                       \
 708         KASSERT(!(curthread->td_pflags & TDP_NOSLEEPING),               \
 709             ("nested no sleeping"));                                    \
 710         curthread->td_pflags |= TDP_NOSLEEPING;                         \
 711 } while (0)
 712
 713 #define THREAD_SLEEPING_OK() do {                                       \
 714         KASSERT((curthread->td_pflags & TDP_NOSLEEPING),                \
 715             ("nested sleeping ok"));                                    \
 716         curthread->td_pflags &= ~TDP_NOSLEEPING;                        \
 717 } while (0)
 718
 719 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
 720 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
 721 extern u_long pidhash;
 722
 723 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
 724 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
 725 extern u_long pgrphash;
 726
 727 extern struct sx allproc_lock;
 728 extern struct sx proctree_lock;
 729 extern struct mtx ppeers_lock;
 730 extern struct proc proc0;               /* Process slot for swapper. */
 731 extern struct thread thread0;           /* Primary thread in proc0. */
 732 extern struct vmspace vmspace0;         /* VM space for proc0. */
 733 extern int hogticks;                    /* Limit on kernel cpu hogs. */
 734 extern int lastpid;
 735 extern int nprocs, maxproc;             /* Current and max number of procs. */
 736 extern int maxprocperuid;               /* Max procs per uid. */
 737 extern u_long ps_arg_cache_limit;
 738
 739 LIST_HEAD(proclist, proc);
 740 TAILQ_HEAD(procqueue, proc);
 741 TAILQ_HEAD(threadqueue, thread);
 742 extern struct proclist allproc;         /* List of all processes. */
 743 extern struct proclist zombproc;        /* List of zombie processes. */
 744 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
 745
 746 extern struct uma_zone *proc_zone;
 747
 748 struct  proc *pfind(pid_t);             /* Find process by id. */
 749 struct  pgrp *pgfind(pid_t);            /* Find process group by id. */
 750 struct  proc *zpfind(pid_t);            /* Find zombie process by id. */
 751
 752 void    ast(struct trapframe *framep);
 753 struct  thread *choosethread(void);
 754 int     cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
 755 int     enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
 756             struct session *sess);
 757 int     enterthispgrp(struct proc *p, struct pgrp *pgrp);
 758 void    faultin(struct proc *p);
 759 void    fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
 760 int     fork1(struct thread *, int, int, struct proc **);
 761 void    fork_exit(void (*)(void *, struct trapframe *), void *,
 762             struct trapframe *);
 763 void    fork_return(struct thread *, struct trapframe *);
 764 int     inferior(struct proc *p);
 765 void    kick_proc0(void);
 766 int     leavepgrp(struct proc *p);
 767 int     maybe_preempt(struct thread *td);
 768 void    mi_switch(int flags, struct thread *newtd);
 769 int     p_candebug(struct thread *td, struct proc *p);
 770 int     p_cansee(struct thread *td, struct proc *p);
 771 int     p_cansched(struct thread *td, struct proc *p);
 772 int     p_cansignal(struct thread *td, struct proc *p, int signum);
 773 int     p_canwait(struct thread *td, struct proc *p);
 774 struct  pargs *pargs_alloc(int len);
 775 void    pargs_drop(struct pargs *pa);
 776 void    pargs_free(struct pargs *pa);
 777 void    pargs_hold(struct pargs *pa);
 778 void    procinit(void);
 779 void    proc_linkup0(struct proc *p, struct thread *td);
 780 void    proc_linkup(struct proc *p, struct thread *td);
 781 void    proc_reparent(struct proc *child, struct proc *newparent);
 782 struct  pstats *pstats_alloc(void);
 783 void    pstats_fork(struct pstats *src, struct pstats *dst);
 784 void    pstats_free(struct pstats *ps);
 785 int     securelevel_ge(struct ucred *cr, int level);
 786 int     securelevel_gt(struct ucred *cr, int level);
 787 void    sessrele(struct session *);
 788 void    setrunnable(struct thread *);
 789 void    setsugid(struct proc *p);
 790 int     sigonstack(size_t sp);
 791 void    sleepinit(void);
 792 void    stopevent(struct proc *, u_int, u_int);
 793 void    threadinit(void);
 794 void    cpu_idle(void);
 795 extern  void (*cpu_idle_hook)(void);    /* Hook to machdep CPU idler. */
 796 void    cpu_switch(struct thread *, struct thread *, struct mtx *);
 797 void    cpu_throw(struct thread *, struct thread *) __dead2;
 798 void    unsleep(struct thread *);
 799 void    userret(struct thread *, struct trapframe *);
 800
 801 void    cpu_exit(struct thread *);
 802 void    exit1(struct thread *, int) __dead2;
 803 void    cpu_fork(struct thread *, struct proc *, struct thread *, int);
 804 void    cpu_set_fork_handler(struct thread *, void (*)(void *), void *);
 805
 806 void    cpu_set_upcall(struct thread *td, struct thread *td0);
 807 void    cpu_set_upcall_kse(struct thread *, void (*)(void *), void *,
 808             stack_t *);
 809 int     cpu_set_user_tls(struct thread *, void *tls_base);
 810 void    cpu_thread_alloc(struct thread *);
 811 void    cpu_thread_clean(struct thread *);
 812 void    cpu_thread_exit(struct thread *);
 813 void    cpu_thread_free(struct thread *);
 814 void    cpu_thread_swapin(struct thread *);
 815 void    cpu_thread_swapout(struct thread *);
 816 struct  thread *thread_alloc(void);
 817 void    thread_exit(void) __dead2;
 818 void    thread_free(struct thread *td);
 819 void    thread_link(struct thread *td, struct proc *p);
 820 void    thread_reap(void);
 821 int     thread_single(int how);
 822 void    thread_single_end(void);
 823 void    thread_stash(struct thread *td);
 824 void    thread_stopped(struct proc *p);
 825 void    childproc_stopped(struct proc *child, int reason);
 826 void    childproc_continued(struct proc *child);
 827 void    childproc_exited(struct proc *child);
 828 int     thread_suspend_check(int how);
 829 void    thread_suspend_switch(struct thread *);
 830 void    thread_suspend_one(struct thread *td);
 831 void    thread_unlink(struct thread *td);
 832 void    thread_unsuspend(struct proc *p);
 833 void    thread_unsuspend_one(struct thread *td);
 834 void    thread_unthread(struct thread *td);
 835 void    thread_wait(struct proc *p);
 836 struct thread   *thread_find(struct proc *p, lwpid_t tid);
 837 void    thr_exit1(void);
 838
 839 #endif  /* _KERNEL */
 840
 841 #endif  /* !_SYS_PROC_H_ */