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/_mutex.h>
  49 #include <sys/priority.h>
  50 #include <sys/rtprio.h>                 /* XXX. */
  51 #include <sys/runq.h>
  52 #include <sys/sigio.h>
  53 #include <sys/signal.h>
  54 #include <sys/signalvar.h>
  55 #ifndef _KERNEL
  56 #include <sys/time.h>                   /* For structs itimerval, timeval. */
  57 #else
  58 #include <sys/pcpu.h>
  59 #endif
  60 #include <sys/ucontext.h>
  61 #include <sys/ucred.h>
  62 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
  63
  64 /*
  65  * One structure allocated per session.
  66  *
  67  * List of locks
  68  * (m)          locked by s_mtx mtx
  69  * (e)          locked by proctree_lock sx
  70  * (c)          const until freeing
  71  */
  72 struct session {
  73         int             s_count;        /* (m) Ref cnt; pgrps in session. */
  74         struct proc     *s_leader;      /* (m + e) Session leader. */
  75         struct vnode    *s_ttyvp;       /* (m) Vnode of controlling tty. */
  76         struct tty      *s_ttyp;        /* (m) Controlling tty. */
  77         pid_t           s_sid;          /* (c) Session ID. */
  78                                         /* (m) Setlogin() name: */
  79         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
  80         struct mtx      s_mtx;          /* Mutex to protect members. */
  81 };
  82
  83 /*
  84  * One structure allocated per process group.
  85  *
  86  * List of locks
  87  * (m)          locked by pg_mtx mtx
  88  * (e)          locked by proctree_lock sx
  89  * (c)          const until freeing
  90  */
  91 struct pgrp {
  92         LIST_ENTRY(pgrp) pg_hash;       /* (e) Hash chain. */
  93         LIST_HEAD(, proc) pg_members;   /* (m + e) Pointer to pgrp members. */
  94         struct session  *pg_session;    /* (c) Pointer to session. */
  95         struct sigiolst pg_sigiolst;    /* (m) List of sigio sources. */
  96         pid_t           pg_id;          /* (c) Process group id. */
  97         int             pg_jobc;        /* (m) Job control process count. */
  98         struct mtx      pg_mtx;         /* Mutex to protect members */
  99 };
 100
 101 /*
 102  * pargs, used to hold a copy of the command line, if it had a sane length.
 103  */
 104 struct pargs {
 105         u_int   ar_ref;         /* Reference count. */
 106         u_int   ar_length;      /* Length. */
 107         u_char  ar_args[1];     /* Arguments. */
 108 };
 109
 110 /*-
 111  * Description of a process.
 112  *
 113  * This structure contains the information needed to manage a thread of
 114  * control, known in UN*X as a process; it has references to substructures
 115  * containing descriptions of things that the process uses, but may share
 116  * with related processes.  The process structure and the substructures
 117  * are always addressable except for those marked "(CPU)" below,
 118  * which might be addressable only on a processor on which the process
 119  * is running.
 120  *
 121  * Below is a key of locks used to protect each member of struct proc.  The
 122  * lock is indicated by a reference to a specific character in parens in the
 123  * associated comment.
 124  *      * - not yet protected
 125  *      a - only touched by curproc or parent during fork/wait
 126  *      b - created at fork, never changes
 127  *              (exception aiods switch vmspaces, but they are also
 128  *              marked 'P_SYSTEM' so hopefully it will be left alone)
 129  *      c - locked by proc mtx
 130  *      d - locked by allproc_lock lock
 131  *      e - locked by proctree_lock lock
 132  *      f - session mtx
 133  *      g - process group mtx
 134  *      h - callout_lock mtx
 135  *      i - by curproc or the master session mtx
 136  *      j - locked by sched_lock mtx
 137  *      k - only accessed by curthread
 138  *      k*- only accessed by curthread and from an interrupt
 139  *      l - the attaching proc or attaching proc parent
 140  *      m - Giant
 141  *      n - not locked, lazy
 142  *      o - ktrace lock
 143  *      p - select lock (sellock)
 144  *      q - td_contested lock
 145  *      r - p_peers lock
 146  *      x - created at fork, only changes during single threading in exec
 147  *      z - zombie threads lock
 148  *
 149  * If the locking key specifies two identifiers (for example, p_pptr) then
 150  * either lock is sufficient for read access, but both locks must be held
 151  * for write access.
 152  */
 153 struct auditinfo;
 154 struct kaudit_record;
 155 #ifdef KSE
 156 struct kg_sched;
 157 #else
 158 struct td_sched;
 159 #endif
 160 struct nlminfo;
 161 struct kaioinfo;
 162 struct p_sched;
 163 struct proc;
 164 struct sleepqueue;
 165 #ifdef KSE
 166 struct td_sched;
 167 #else
 168 struct thread;
 169 #endif
 170 struct trapframe;
 171 struct turnstile;
 172 struct mqueue_notifier;
 173
 174 #ifdef KSE
 175 /*
 176  * Here we define the three structures used for process information.
 177  *
 178  * The first is the thread. It might be thought of as a "Kernel
 179  * Schedulable Entity Context".
 180  * This structure contains all the information as to where a thread of
 181  * execution is now, or was when it was suspended, why it was suspended,
 182  * and anything else that will be needed to restart it when it is
 183  * rescheduled. Always associated with a KSE when running, but can be
 184  * reassigned to an equivalent KSE when being restarted for
 185  * load balancing. Each of these is associated with a kernel stack
 186  * and a pcb.
 187  *
 188  * It is important to remember that a particular thread structure may only
 189  * exist as long as the system call or kernel entrance (e.g. by pagefault)
 190  * which it is currently executing. It should therefore NEVER be referenced
 191  * by pointers in long lived structures that live longer than a single
 192  * request. If several threads complete their work at the same time,
 193  * they will all rewind their stacks to the user boundary, report their
 194  * completion state, and all but one will be freed. That last one will
 195  * be kept to provide a kernel stack and pcb for the NEXT syscall or kernel
 196  * entrance (basically to save freeing and then re-allocating it).  The existing
 197  * thread keeps a cached spare thread available to allow it to quickly
 198  * get one when it needs a new one. There is also a system
 199  * cache of free threads. Threads have priority and partake in priority
 200  * inheritance schemes.
 201  */
 202 struct thread;
 203
 204 /*
 205  * The KSEGRP is allocated resources across a number of CPUs.
 206  * (Including a number of CPUxQUANTA. It parcels these QUANTA up among
 207  * its threads, each of which should be running in a different CPU.
 208  * BASE priority and total available quanta are properties of a KSEGRP.
 209  * Multiple KSEGRPs in a single process compete against each other
 210  * for total quanta in the same way that a forked child competes against
 211  * it's parent process.
 212  */
 213 struct ksegrp;
 214
 215 /*
 216  * A process is the owner of all system resources allocated to a task
 217  * except CPU quanta.
 218  * All KSEGs under one process see, and have the same access to, these
 219  * resources (e.g. files, memory, sockets, credential, kqueues).
 220  * A process may compete for CPU cycles on the same basis as a
 221  * forked process cluster by spawning several KSEGRPs.
 222  */
 223 struct proc;
 224
 225 /***************
 226  * In pictures:
 227  With a single run queue used by all processors:
 228
 229  RUNQ: --->KSE---KSE--...               SLEEPQ:[]---THREAD---THREAD---THREAD
 230              \      \                          []---THREAD
 231       KSEG---THREAD--THREAD--THREAD            []
 232                                                []---THREAD---THREAD
 233
 234   (processors run THREADs from the KSEG until they are exhausted or
 235   the KSEG exhausts its quantum)
 236
 237 With PER-CPU run queues:
 238 KSEs on the separate run queues directly
 239 They would be given priorities calculated from the KSEG.
 240
 241  *
 242  *****************/
 243 #endif
 244
 245 #ifdef KSE
 246 /*
 247  * Kernel runnable context (thread).
 248  * This is what is put to sleep and reactivated.
 249  * The first KSE available in the correct group will run this thread.
 250  * If several are available, use the one on the same CPU as last time.
 251  * When waiting to be run, threads are hung off the KSEGRP in priority order.
 252  * With N runnable and queued KSEs in the KSEGRP, the first N threads
 253  * are linked to them. Other threads are not yet assigned.
 254  */
 255 #else
 256 /*
 257  * Thread context.  Processes may have multiple threads.
 258  */
 259 #endif
 260 struct thread {
 261         struct proc     *td_proc;       /* (*) Associated process. */
 262 #ifdef KSE
 263         struct ksegrp   *td_ksegrp;     /* (*) Associated KSEG. */
 264 #else
 265         void    *was_td_ksegrp;         /* Temporary padding. */
 266 #endif
 267         TAILQ_ENTRY(thread) td_plist;   /* (*) All threads in this proc. */
 268 #ifdef KSE
 269         TAILQ_ENTRY(thread) td_kglist;  /* (*) All threads in this ksegrp. */
 270 #else
 271         TAILQ_ENTRY(thread) was_td_kglist;      /* Temporary padding. */
 272 #endif
 273
 274         /* The two queues below should someday be merged. */
 275         TAILQ_ENTRY(thread) td_slpq;    /* (j) Sleep queue. */
 276         TAILQ_ENTRY(thread) td_lockq;   /* (j) Lock queue. */
 277 #ifdef KSE
 278         TAILQ_ENTRY(thread) td_runq;    /* (j/z) Run queue(s). XXXKSE */
 279 #else
 280         TAILQ_ENTRY(thread) td_runq;    /* (j/z) Run queue(s). */
 281 #endif
 282
 283         TAILQ_HEAD(, selinfo) td_selq;  /* (p) List of selinfos. */
 284         struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
 285         struct turnstile *td_turnstile; /* (k) Associated turnstile. */
 286         struct umtx_q   *td_umtxq;      /* (c?) Link for when we're blocked. */
 287         lwpid_t         td_tid;         /* (b) Thread ID. */
 288         sigqueue_t      td_sigqueue;    /* (c) Sigs arrived, not delivered. */
 289 #define td_siglist      td_sigqueue.sq_signals
 290
 291 /* Cleared during fork1() or thread_schedule_upcall(). */
 292 #define td_startzero td_flags
 293         int             td_flags;       /* (j) TDF_* flags. */
 294         int             td_inhibitors;  /* (j) Why can not run. */
 295         int             td_pflags;      /* (k) Private thread (TDP_*) flags. */
 296         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
 297         void            *td_wchan;      /* (j) Sleep address. */
 298         const char      *td_wmesg;      /* (j) Reason for sleep. */
 299         u_char          td_lastcpu;     /* (j) Last cpu we were on. */
 300         u_char          td_oncpu;       /* (j) Which cpu we are on. */
 301         volatile u_char td_owepreempt;  /* (k*) Preempt on last critical_exit */
 302         short           td_locks;       /* (k) Count of non-spin locks. */
 303         u_char          td_tsqueue;     /* (j) Turnstile queue blocked on. */
 304         struct turnstile *td_blocked;   /* (j) Lock thread is blocked on. */
 305         const char      *td_lockname;   /* (j) Name of lock blocked on. */
 306         LIST_HEAD(, turnstile) td_contested;    /* (q) Contested locks. */
 307         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
 308         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
 309         int             td_pinned;      /* (k) Temporary cpu pin count. */
 310 #ifdef KSE
 311         struct kse_thr_mailbox *td_mailbox; /* (*) Userland mailbox address. */
 312 #else
 313         void    *was_td_mailbox;        /* Temporary padding. */
 314 #endif
 315         struct ucred    *td_ucred;      /* (k) Reference to credentials. */
 316 #ifdef KSE
 317         struct thread   *td_standin;    /* (k + a) Use this for an upcall. */
 318         struct kse_upcall *td_upcall;   /* (k + j) Upcall structure. */
 319         u_int           new_td_estcpu;  /*  Temporary padding. */
 320         u_int           new_td_slptime; /*  Temporary padding. */
 321 #else
 322         void            *was_td_standin;        /* Temporary padding. */
 323         void            *was_td_upcall;         /* Temporary padding. */
 324         u_int           td_estcpu;      /* (j) Sum of the same field in KSEs. */
 325         u_int           td_slptime;     /* (j) How long completely blocked. */
 326 #endif
 327         u_int           td_pticks;      /* (k) Statclock hits for profiling */
 328         u_int           td_sticks;      /* (k) Statclock hits in system mode. */
 329         u_int           td_iticks;      /* (k) Statclock hits in intr mode. */
 330         u_int           td_uticks;      /* (k) Statclock hits in user mode. */
 331         u_int           td_uuticks;     /* (k) Statclock hits (usr), for UTS. */
 332         u_int           td_usticks;     /* (k) Statclock hits (sys), for UTS. */
 333         int             td_intrval;     /* (j) Return value of TDF_INTERRUPT. */
 334         sigset_t        td_oldsigmask;  /* (k) Saved mask from pre sigpause. */
 335         sigset_t        td_sigmask;     /* (c) Current signal mask. */
 336         volatile u_int  td_generation;  /* (k) For detection of preemption */
 337         stack_t         td_sigstk;      /* (k) Stack ptr and on-stack flag. */
 338 #ifdef KSE
 339         int             td_kflags;      /* (c) Flags for KSE threading. */
 340 #else
 341         int             was_td_kflags;  /* Temporary padding. */
 342 #endif
 343         int             td_xsig;        /* (c) Signal for ptrace */
 344         u_long          td_profil_addr; /* (k) Temporary addr until AST. */
 345         u_int           td_profil_ticks; /* (k) Temporary ticks until AST. */
 346         char            td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
 347 #define td_endzero td_base_pri
 348
 349 /* Copied during fork1() or thread_sched_upcall(). */
 350 #define td_startcopy td_endzero
 351         u_char          td_base_pri;    /* (j) Thread base kernel priority. */
 352         u_char          td_priority;    /* (j) Thread active priority. */
 353 #ifdef KSE
 354         u_char          new_td_pri_class;       /* Temporary padding. */
 355         u_char          new_td_user_pri;        /* Temporary padding. */
 356         u_char          new_td_base_user_pri;   /* Temporary padding. */
 357 #else
 358         u_char          td_pri_class;   /* (j) Scheduling class. */
 359         u_char          td_user_pri;    /* (j) User pri from estcpu and nice. */
 360         u_char          td_base_user_pri;       /* (j) Base user pri */
 361 #endif
 362 #define td_endcopy td_pcb
 363
 364 /*
 365  * Fields that must be manually set in fork1() or thread_sched_upcall()
 366  * or already have been set in the allocator, constructor, etc.
 367  */
 368         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
 369         enum {
 370                 TDS_INACTIVE = 0x0,
 371                 TDS_INHIBITED,
 372                 TDS_CAN_RUN,
 373                 TDS_RUNQ,
 374                 TDS_RUNNING
 375         } td_state;
 376         register_t      td_retval[2];   /* (k) Syscall aux returns. */
 377         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
 378         struct trapframe *td_frame;     /* (k) */
 379         struct vm_object *td_kstack_obj;/* (a) Kstack object. */
 380         vm_offset_t     td_kstack;      /* (a) Kernel VA of kstack. */
 381         int             td_kstack_pages; /* (a) Size of the kstack. */
 382         struct vm_object *td_altkstack_obj;/* (a) Alternate kstack object. */
 383         vm_offset_t     td_altkstack;   /* (a) Kernel VA of alternate kstack. */
 384         int             td_altkstack_pages; /* (a) Size of alternate kstack. */
 385         volatile u_int  td_critnest;    /* (k*) Critical section nest level. */
 386         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
 387         struct td_sched *td_sched;      /* (*) Scheduler-specific data. */
 388         struct kaudit_record    *td_ar; /* (k) Active audit record, if any. */
 389 };
 390
 391 /*
 392  * Flags kept in td_flags:
 393  * To change these you MUST have the scheduler lock.
 394  */
 395 #define TDF_BORROWING   0x00000001 /* Thread is borrowing pri from another. */
 396 #define TDF_INPANIC     0x00000002 /* Caused a panic, let it drive crashdump. */
 397 #define TDF_SINTR       0x00000008 /* Sleep is interruptible. */
 398 #define TDF_TIMEOUT     0x00000010 /* Timing out during sleep. */
 399 #define TDF_IDLETD      0x00000020 /* This is a per-CPU idle thread. */
 400 #define TDF_SELECT      0x00000040 /* Selecting; wakeup/waiting danger. */
 401 #define TDF_SLEEPABORT  0x00000080 /* sleepq_abort was called. */
 402 #define TDF_TSNOBLOCK   0x00000100 /* Don't block on a turnstile due to race. */
 403 #define TDF_UBORROWING  0x00000200 /* Thread is borrowing user pri. */
 404 #define TDF_BOUNDARY    0x00000400 /* Thread suspended at user boundary */
 405 #define TDF_ASTPENDING  0x00000800 /* Thread has some asynchronous events. */
 406 #define TDF_TIMOFAIL    0x00001000 /* Timeout from sleep after we were awake. */
 407 #define TDF_INTERRUPT   0x00002000 /* Thread is marked as interrupted. */
 408 #define TDF_UPIBLOCKED  0x00004000 /* Thread blocked on user PI mutex. */
 409 #define TDF_UNUSED15    0x00008000 /* --available -- */
 410 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
 411 #define TDF_NEEDSIGCHK  0x00020000 /* Thread may need signal delivery. */
 412 #define TDF_XSIG        0x00040000 /* Thread is exchanging signal under trace */
 413 #define TDF_UNUSED19    0x00080000 /* Thread is sleeping on a umtx. */
 414 #define TDF_THRWAKEUP   0x00100000 /* Libthr thread must not suspend itself. */
 415 #define TDF_DBSUSPEND   0x00200000 /* Thread is suspended by debugger */
 416 #define TDF_UNUSED22    0x00400000 /* --available -- */
 417 #define TDF_UNUSED23    0x00800000 /* --available -- */
 418 #define TDF_SCHED0      0x01000000 /* Reserved for scheduler private use */
 419 #define TDF_SCHED1      0x02000000 /* Reserved for scheduler private use */
 420 #define TDF_SCHED2      0x04000000 /* Reserved for scheduler private use */
 421 #define TDF_SCHED3      0x08000000 /* Reserved for scheduler private use */
 422
 423 /*
 424  * "Private" flags kept in td_pflags:
 425  * These are only accessed by curthread and thus need no locking.
 426  */
 427 #define TDP_OLDMASK     0x00000001 /* Need to restore mask after suspend. */
 428 #define TDP_INKTR       0x00000002 /* Thread is currently in KTR code. */
 429 #define TDP_INKTRACE    0x00000004 /* Thread is currently in KTRACE code. */
 430 #ifdef KSE
 431 #define TDP_UPCALLING   0x00000008 /* This thread is doing an upcall. */
 432 #else
 433 /*                      0x00000008 */
 434 #endif
 435 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
 436 #define TDP_ALTSTACK    0x00000020 /* Have alternate signal stack. */
 437 #define TDP_DEADLKTREAT 0x00000040 /* Lock aquisition - deadlock treatment. */
 438 #ifdef KSE
 439 #define TDP_SA          0x00000080 /* A scheduler activation based thread. */
 440 #else
 441 /*                      0x00000080 */
 442 #endif
 443 #define TDP_NOSLEEPING  0x00000100 /* Thread is not allowed to sleep on a sq. */
 444 #define TDP_OWEUPC      0x00000200 /* Call addupc() at next AST. */
 445 #define TDP_ITHREAD     0x00000400 /* Thread is an interrupt thread. */
 446 #ifdef KSE
 447 #define TDP_CAN_UNBIND  0x00000800 /* Only temporarily bound. */
 448 #else
 449 /*                      0x00000800 */
 450 #endif
 451 #define TDP_SCHED1      0x00001000 /* Reserved for scheduler private use */
 452 #define TDP_SCHED2      0x00002000 /* Reserved for scheduler private use */
 453 #define TDP_SCHED3      0x00004000 /* Reserved for scheduler private use */
 454 #define TDP_SCHED4      0x00008000 /* Reserved for scheduler private use */
 455 #define TDP_GEOM        0x00010000 /* Settle GEOM before finishing syscall */
 456 #define TDP_SOFTDEP     0x00020000 /* Stuck processing softdep worklist */
 457 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
 458
 459 /*
 460  * Reasons that the current thread can not be run yet.
 461  * More than one may apply.
 462  */
 463 #define TDI_SUSPENDED   0x0001  /* On suspension queue. */
 464 #define TDI_SLEEPING    0x0002  /* Actually asleep! (tricky). */
 465 #define TDI_SWAPPED     0x0004  /* Stack not in mem.  Bad juju if run. */
 466 #define TDI_LOCK        0x0008  /* Stopped on a lock. */
 467 #define TDI_IWAIT       0x0010  /* Awaiting interrupt. */
 468
 469 #ifdef KSE
 470 /*
 471  * flags (in kflags) related to M:N threading.
 472  */
 473 #define TDK_KSEREL      0x0001  /* Blocked in msleep on kg->kg_completed. */
 474 #define TDK_KSERELSIG   0x0002  /* Blocked in msleep on p->p_siglist. */
 475 #define TDK_WAKEUP      0x0004  /* Thread has been woken by kse_wakeup. */
 476
 477 #define TD_CAN_UNBIND(td)                       \
 478     (((td)->td_pflags & TDP_CAN_UNBIND) &&      \
 479      ((td)->td_upcall != NULL))
 480 #endif
 481
 482 #define TD_IS_SLEEPING(td)      ((td)->td_inhibitors & TDI_SLEEPING)
 483 #define TD_ON_SLEEPQ(td)        ((td)->td_wchan != NULL)
 484 #define TD_IS_SUSPENDED(td)     ((td)->td_inhibitors & TDI_SUSPENDED)
 485 #define TD_IS_SWAPPED(td)       ((td)->td_inhibitors & TDI_SWAPPED)
 486 #define TD_ON_LOCK(td)          ((td)->td_inhibitors & TDI_LOCK)
 487 #define TD_AWAITING_INTR(td)    ((td)->td_inhibitors & TDI_IWAIT)
 488 #define TD_IS_RUNNING(td)       ((td)->td_state == TDS_RUNNING)
 489 #define TD_ON_RUNQ(td)          ((td)->td_state == TDS_RUNQ)
 490 #define TD_CAN_RUN(td)          ((td)->td_state == TDS_CAN_RUN)
 491 #define TD_IS_INHIBITED(td)     ((td)->td_state == TDS_INHIBITED)
 492 #define TD_ON_UPILOCK(td)       ((td)->td_flags & TDF_UPIBLOCKED)
 493
 494 #define TD_SET_INHIB(td, inhib) do {                    \
 495         (td)->td_state = TDS_INHIBITED;                 \
 496         (td)->td_inhibitors |= (inhib);                 \
 497 } while (0)
 498
 499 #define TD_CLR_INHIB(td, inhib) do {                    \
 500         if (((td)->td_inhibitors & (inhib)) &&          \
 501             (((td)->td_inhibitors &= ~(inhib)) == 0))   \
 502                 (td)->td_state = TDS_CAN_RUN;           \
 503 } while (0)
 504
 505 #define TD_SET_SLEEPING(td)     TD_SET_INHIB((td), TDI_SLEEPING)
 506 #define TD_SET_SWAPPED(td)      TD_SET_INHIB((td), TDI_SWAPPED)
 507 #define TD_SET_LOCK(td)         TD_SET_INHIB((td), TDI_LOCK)
 508 #define TD_SET_SUSPENDED(td)    TD_SET_INHIB((td), TDI_SUSPENDED)
 509 #define TD_SET_IWAIT(td)        TD_SET_INHIB((td), TDI_IWAIT)
 510 #define TD_SET_EXITING(td)      TD_SET_INHIB((td), TDI_EXITING)
 511
 512 #define TD_CLR_SLEEPING(td)     TD_CLR_INHIB((td), TDI_SLEEPING)
 513 #define TD_CLR_SWAPPED(td)      TD_CLR_INHIB((td), TDI_SWAPPED)
 514 #define TD_CLR_LOCK(td)         TD_CLR_INHIB((td), TDI_LOCK)
 515 #define TD_CLR_SUSPENDED(td)    TD_CLR_INHIB((td), TDI_SUSPENDED)
 516 #define TD_CLR_IWAIT(td)        TD_CLR_INHIB((td), TDI_IWAIT)
 517
 518 #define TD_SET_RUNNING(td)      (td)->td_state = TDS_RUNNING
 519 #define TD_SET_RUNQ(td)         (td)->td_state = TDS_RUNQ
 520 #define TD_SET_CAN_RUN(td)      (td)->td_state = TDS_CAN_RUN
 521
 522 #ifdef KSE
 523 /*
 524  * An upcall is used when returning to userland.  If a thread does not have
 525  * an upcall on return to userland the thread exports its context and exits.
 526  */
 527 struct kse_upcall {
 528         TAILQ_ENTRY(kse_upcall) ku_link;        /* List of upcalls in KSEG. */
 529         struct ksegrp           *ku_ksegrp;     /* Associated KSEG. */
 530         struct thread           *ku_owner;      /* Owning thread. */
 531         int                     ku_flags;       /* KUF_* flags. */
 532         struct kse_mailbox      *ku_mailbox;    /* Userland mailbox address. */
 533         stack_t                 ku_stack;       /* Userland upcall stack. */
 534         void                    *ku_func;       /* Userland upcall function. */
 535         unsigned int            ku_mflags;      /* Cached upcall mbox flags. */
 536 };
 537
 538 #define KUF_DOUPCALL    0x00001         /* Do upcall now; don't wait. */
 539 #define KUF_EXITING     0x00002         /* Upcall structure is exiting. */
 540
 541 /*
 542  * Kernel-scheduled entity group (KSEG).  The scheduler considers each KSEG to
 543  * be an indivisible unit from a time-sharing perspective, though each KSEG may
 544  * contain multiple KSEs.
 545  */
 546 struct ksegrp {
 547         struct proc     *kg_proc;       /* (*) Proc that contains this KSEG. */
 548         TAILQ_ENTRY(ksegrp) kg_ksegrp;  /* (*) Queue of KSEGs in kg_proc. */
 549         TAILQ_HEAD(, thread) kg_threads;/* (td_kglist) All threads. */
 550         TAILQ_HEAD(, thread) kg_runq;   /* (td_runq) waiting RUNNABLE threads */
 551         TAILQ_HEAD(, kse_upcall) kg_upcalls;    /* All upcalls in the group. */
 552
 553 #define kg_startzero kg_estcpu
 554         u_int           kg_estcpu;      /* (j) Sum of the same field in KSEs. */
 555         u_int           kg_slptime;     /* (j) How long completely blocked. */
 556         int             kg_numupcalls;  /* (j) Num upcalls. */
 557         int             kg_upsleeps;    /* (c) Num threads in kse_release(). */
 558         struct kse_thr_mailbox *kg_completed; /* (c) Completed thread mboxes. */
 559         int             kg_nextupcall;  /* (n) Next upcall time. */
 560         int             kg_upquantum;   /* (n) Quantum to schedule an upcall. */
 561 #define kg_endzero kg_pri_class
 562
 563 #define kg_startcopy    kg_endzero
 564         u_char          kg_pri_class;   /* (j) Scheduling class. */
 565         u_char          kg_user_pri;    /* (j) User pri from estcpu and nice. */
 566         u_char          kg_base_user_pri;       /* (j) Base user pri */
 567 #define kg_endcopy kg_numthreads
 568         int             kg_numthreads;  /* (j) Num threads in total. */
 569         struct kg_sched *kg_sched;      /* (*) Scheduler-specific data. */
 570 };
 571 #endif
 572
 573 /*
 574  * XXX: Does this belong in resource.h or resourcevar.h instead?
 575  * Resource usage extension.  The times in rusage structs in the kernel are
 576  * never up to date.  The actual times are kept as runtimes and tick counts
 577  * (with control info in the "previous" times), and are converted when
 578  * userland asks for rusage info.  Backwards compatibility prevents putting
 579  * this directly in the user-visible rusage struct.
 580  *
 581  * Locking: (cj) means (j) for p_rux and (c) for p_crux.
 582  */
 583 struct rusage_ext {
 584         u_int64_t       rux_runtime;    /* (cj) Real time. */
 585         u_int64_t       rux_uticks;     /* (cj) Statclock hits in user mode. */
 586         u_int64_t       rux_sticks;     /* (cj) Statclock hits in sys mode. */
 587         u_int64_t       rux_iticks;     /* (cj) Statclock hits in intr mode. */
 588         u_int64_t       rux_uu;         /* (c) Previous user time in usec. */
 589         u_int64_t       rux_su;         /* (c) Previous sys time in usec. */
 590         u_int64_t       rux_tu;         /* (c) Previous total time in usec. */
 591 };
 592
 593 /*
 594  * The old fashionned process. May have multiple threads, KSEGRPs
 595  * and KSEs. Starts off with a single embedded KSEGRP and THREAD.
 596  */
 597 struct proc {
 598         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
 599 #ifdef KSE
 600         TAILQ_HEAD(, ksegrp) p_ksegrps; /* (c)(kg_ksegrp) All KSEGs. */
 601 #else
 602         TAILQ_HEAD(, thread) was_p_ksegrps;     /* Temporary padding. */
 603 #endif
 604         TAILQ_HEAD(, thread) p_threads; /* (j)(td_plist) Threads. (shortcut) */
 605         TAILQ_HEAD(, thread) p_suspended; /* (td_runq) Suspended threads. */
 606         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
 607         struct filedesc *p_fd;          /* (b) Open files. */
 608         struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
 609                                         /* Accumulated stats for all threads? */
 610         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
 611         struct plimit   *p_limit;       /* (c) Process limits. */
 612         struct sigacts  *p_sigacts;     /* (x) Signal actions, state (CPU). */
 613
 614         /*
 615          * The following don't make too much sense.
 616          * See the td_ or ke_ versions of the same flags.
 617          */
 618         int             p_flag;         /* (c) P_* flags. */
 619         int             p_sflag;        /* (j) PS_* flags. */
 620         enum {
 621                 PRS_NEW = 0,            /* In creation */
 622                 PRS_NORMAL,             /* threads can be run. */
 623                 PRS_ZOMBIE
 624         } p_state;                      /* (j/c) S* process status. */
 625
 626         pid_t           p_pid;          /* (b) Process identifier. */
 627         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
 628         LIST_ENTRY(proc) p_pglist;      /* (g + e) List of processes in pgrp. */
 629         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
 630         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
 631         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
 632         struct mtx      p_mtx;          /* (n) Lock for this struct. */
 633         struct ksiginfo *p_ksi; /* Locked by parent proc lock */
 634         sigqueue_t      p_sigqueue;     /* (c) Sigs not delivered to a td. */
 635 #define p_siglist       p_sigqueue.sq_signals
 636
 637 /* The following fields are all zeroed upon creation in fork. */
 638 #define p_startzero     p_oppid
 639         pid_t           p_oppid;        /* (c + e) Save ppid in ptrace. XXX */
 640         struct vmspace  *p_vmspace;     /* (b) Address space. */
 641         u_int           p_swtime;       /* (j) Time swapped in or out. */
 642         struct itimerval p_realtimer;   /* (c) Alarm timer. */
 643         struct rusage_ext p_rux;        /* (cj) Internal resource usage. */
 644         struct rusage_ext p_crux;       /* (c) Internal child resource usage. */
 645         int             p_profthreads;  /* (c) Num threads in addupc_task. */
 646         int             p_maxthrwaits;  /* (c) Max threads num waiters */
 647         int             p_traceflag;    /* (o) Kernel trace points. */
 648         struct vnode    *p_tracevp;     /* (c + o) Trace to vnode. */
 649         struct ucred    *p_tracecred;   /* (o) Credentials to trace with. */
 650         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
 651         char            p_lock;         /* (c) Proclock (prevent swap) count. */
 652         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
 653         int             p_sigparent;    /* (c) Signal to parent on exit. */
 654         int             p_sig;          /* (n) For core dump/debugger XXX. */
 655         u_long          p_code;         /* (n) For core dump/debugger XXX. */
 656         u_int           p_stops;        /* (c) Stop event bitmask. */
 657         u_int           p_stype;        /* (c) Stop event type. */
 658         char            p_step;         /* (c) Process is stopped. */
 659         u_char          p_pfsflags;     /* (c) Procfs flags. */
 660         struct nlminfo  *p_nlminfo;     /* (?) Only used by/for lockd. */
 661         struct kaioinfo *p_aioinfo;     /* (c) ASYNC I/O info. */
 662         struct thread   *p_singlethread;/* (c + j) If single threading this is it */
 663         int             p_suspcount;    /* (c) Num threads in suspended mode. */
 664         struct thread   *p_xthread;     /* (c) Trap thread */
 665         int             p_boundary_count;/* (c) Num threads at user boundary */
 666         int             p_pendingcnt;   /* how many signals are pending */
 667         struct itimers  *p_itimers;     /* (c) POSIX interval timers. */
 668 /* End area that is zeroed on creation. */
 669 #define p_endzero       p_magic
 670
 671 /* The following fields are all copied upon creation in fork. */
 672 #define p_startcopy     p_endzero
 673         u_int           p_magic;        /* (b) Magic number. */
 674         char            p_comm[MAXCOMLEN + 1];  /* (b) Process name. */
 675         struct pgrp     *p_pgrp;        /* (c + e) Pointer to process group. */
 676         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
 677         struct pargs    *p_args;        /* (c) Process arguments. */
 678         rlim_t          p_cpulimit;     /* (j) Current CPU limit in seconds. */
 679         signed char     p_nice;         /* (c + j) Process "nice" value. */
 680 /* End area that is copied on creation. */
 681 #define p_endcopy       p_xstat
 682
 683         u_short         p_xstat;        /* (c) Exit status; also stop sig. */
 684         struct knlist   p_klist;        /* (c) Knotes attached to this proc. */
 685         int             p_numthreads;   /* (j) Number of threads. */
 686 #ifdef KSE
 687         int             p_numksegrps;   /* (c) Number of ksegrps. */
 688 #else
 689         int             was_p_numksegrps;       /* Temporary padding. */
 690 #endif
 691         struct mdproc   p_md;           /* Any machine-dependent fields. */
 692         struct callout  p_itcallout;    /* (h + c) Interval timer callout. */
 693         u_short         p_acflag;       /* (c) Accounting flags. */
 694         struct rusage   *p_ru;          /* (a) Exit information. XXX */
 695         struct proc     *p_peers;       /* (r) */
 696         struct proc     *p_leader;      /* (b) */
 697         void            *p_emuldata;    /* (c) Emulator state data. */
 698         struct label    *p_label;       /* (*) Proc (not subject) MAC label. */
 699         struct p_sched  *p_sched;       /* (*) Scheduler-specific data. */
 700         STAILQ_HEAD(, ktr_request)      p_ktr;  /* (o) KTR event queue. */
 701         LIST_HEAD(, mqueue_notifier)    p_mqnotifier; /* (c) mqueue notifiers.*/
 702         struct auditinfo        *p_au;  /* (c) Process audit properties. */
 703 };
 704
 705 #define p_session       p_pgrp->pg_session
 706 #define p_pgid          p_pgrp->pg_id
 707
 708 #define NOCPU   0xff            /* For when we aren't on a CPU. */
 709
 710
 711 /* These flags are kept in p_flag. */
 712 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
 713 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
 714 #define P_KTHREAD       0x00004 /* Kernel thread (*). */
 715 #define P_NOLOAD        0x00008 /* Ignore during load avg calculations. */
 716 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
 717 #define P_PROFIL        0x00020 /* Has started profiling. */
 718 #define P_STOPPROF      0x00040 /* Has thread requesting to stop profiling. */
 719 #define P_HADTHREADS    0x00080 /* Has had threads (no cleanup shortcuts) */
 720 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
 721 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
 722 #define P_SINGLE_EXIT   0x00400 /* Threads suspending should exit, not wait. */
 723 #define P_TRACED        0x00800 /* Debugged process being traced. */
 724 #define P_WAITED        0x01000 /* Someone is waiting for us. */
 725 #define P_WEXIT         0x02000 /* Working on exiting. */
 726 #define P_EXEC          0x04000 /* Process called exec. */
 727 #define P_SA            0x08000 /* Using scheduler activations. */
 728 #define P_CONTINUED     0x10000 /* Proc has continued from a stopped state. */
 729 #define P_STOPPED_SIG   0x20000 /* Stopped due to SIGSTOP/SIGTSTP. */
 730 #define P_STOPPED_TRACE 0x40000 /* Stopped because of tracing. */
 731 #define P_STOPPED_SINGLE 0x80000 /* Only 1 thread can continue (not to user). */
 732 #define P_PROTECTED     0x100000 /* Do not kill on memory overcommit. */
 733 #define P_SIGEVENT      0x200000 /* Process pending signals changed. */
 734 #define P_SINGLE_BOUNDARY 0x400000 /* Threads should suspend at user boundary. */
 735 #define P_HWPMC         0x800000 /* Process is using HWPMCs */
 736
 737 #define P_JAILED        0x1000000 /* Process is in jail. */
 738 #define P_INEXEC        0x4000000 /* Process is in execve(). */
 739 #define P_STATCHILD     0x8000000 /* Child process stopped or exited. */
 740
 741 #define P_STOPPED       (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
 742 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
 743
 744 /* These flags are kept in p_sflag and are protected with sched_lock. */
 745 #define PS_INMEM        0x00001 /* Loaded into memory. */
 746 #define PS_XCPU         0x00002 /* Exceeded CPU limit. */
 747 #define PS_ALRMPEND     0x00020 /* Pending SIGVTALRM needs to be posted. */
 748 #define PS_PROFPEND     0x00040 /* Pending SIGPROF needs to be posted. */
 749 #define PS_SWAPINREQ    0x00100 /* Swapin request due to wakeup. */
 750 #define PS_SWAPPINGOUT  0x00200 /* Process is being swapped out. */
 751 #define PS_SWAPPINGIN   0x04000 /* Process is being swapped in. */
 752 #define PS_MACPEND      0x08000 /* AST-based MAC event pending. */
 753
 754 /*
 755  * These were process status values (p_stat), now they are only used in
 756  * legacy conversion code.
 757  */
 758 #define SIDL    1               /* Process being created by fork. */
 759 #define SRUN    2               /* Currently runnable. */
 760 #define SSLEEP  3               /* Sleeping on an address. */
 761 #define SSTOP   4               /* Process debugging or suspension. */
 762 #define SZOMB   5               /* Awaiting collection by parent. */
 763 #define SWAIT   6               /* Waiting for interrupt. */
 764 #define SLOCK   7               /* Blocked on a lock. */
 765
 766 #define P_MAGIC         0xbeefface
 767
 768 #ifdef _KERNEL
 769
 770 /* Flags for mi_switch(). */
 771 #define SW_VOL          0x0001          /* Voluntary switch. */
 772 #define SW_INVOL        0x0002          /* Involuntary switch. */
 773 #define SW_PREEMPT      0x0004          /* The invol switch is a preemption */
 774
 775 /* Flags for setrunqueue().  Why are we setting this thread on the run queue? */
 776 #define SRQ_BORING      0x0000          /* No special circumstances. */
 777 #define SRQ_YIELDING    0x0001          /* We are yielding (from mi_switch). */
 778 #define SRQ_OURSELF     0x0002          /* It is ourself (from mi_switch). */
 779 #define SRQ_INTR        0x0004          /* It is probably urgent. */
 780 #define SRQ_PREEMPTED   0x0008          /* has been preempted.. be kind */
 781
 782 /* How values for thread_single(). */
 783 #define SINGLE_NO_EXIT  0
 784 #define SINGLE_EXIT     1
 785 #define SINGLE_BOUNDARY 2
 786
 787 /* XXXKSE: Missing values for thread_suspsend_check(). */
 788
 789 #ifdef MALLOC_DECLARE
 790 MALLOC_DECLARE(M_PARGS);
 791 MALLOC_DECLARE(M_PGRP);
 792 MALLOC_DECLARE(M_SESSION);
 793 MALLOC_DECLARE(M_SUBPROC);
 794 MALLOC_DECLARE(M_ZOMBIE);
 795 #endif
 796
 797 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
 798         LIST_FOREACH((p), &allproc, p_list)
 799 #ifdef KSE
 800 #define FOREACH_KSEGRP_IN_PROC(p, kg)                                   \
 801         TAILQ_FOREACH((kg), &(p)->p_ksegrps, kg_ksegrp)
 802 #define FOREACH_THREAD_IN_GROUP(kg, td)                                 \
 803         TAILQ_FOREACH((td), &(kg)->kg_threads, td_kglist)
 804 #define FOREACH_UPCALL_IN_GROUP(kg, ku)                                 \
 805         TAILQ_FOREACH((ku), &(kg)->kg_upcalls, ku_link)
 806 #endif
 807 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
 808         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
 809
 810 /* XXXKSE the following lines should probably only be used in 1:1 code: */
 811 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
 812 #ifdef KSE
 813 #define FIRST_KSEGRP_IN_PROC(p) TAILQ_FIRST(&(p)->p_ksegrps)
 814 #endif
 815
 816 /*
 817  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
 818  * as it is used to represent "no process group".
 819  */
 820 #define PID_MAX         99999
 821 #define NO_PID          100000
 822
 823 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
 824 #define SESSHOLD(s)     ((s)->s_count++)
 825 #define SESSRELE(s)     sessrele(s)
 826
 827
 828 #define STOPEVENT(p, e, v) do {                                         \
 829         if ((p)->p_stops & (e)) {                                       \
 830                 PROC_LOCK(p);                                           \
 831                 stopevent((p), (e), (v));                               \
 832                 PROC_UNLOCK(p);                                         \
 833         }                                                               \
 834 } while (0)
 835 #define _STOPEVENT(p, e, v) do {                                        \
 836         PROC_LOCK_ASSERT(p, MA_OWNED);                                  \
 837         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.mtx_object, \
 838             "checking stopevent %d", (e));                              \
 839         if ((p)->p_stops & (e))                                         \
 840                 stopevent((p), (e), (v));                               \
 841 } while (0)
 842
 843 /* Lock and unlock a process. */
 844 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
 845 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
 846 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
 847 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
 848 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
 849
 850 /* Lock and unlock a process group. */
 851 #define PGRP_LOCK(pg)   mtx_lock(&(pg)->pg_mtx)
 852 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
 853 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
 854 #define PGRP_LOCK_ASSERT(pg, type)      mtx_assert(&(pg)->pg_mtx, (type))
 855
 856 #define PGRP_LOCK_PGSIGNAL(pg) do {                                     \
 857         if ((pg) != NULL)                                               \
 858                 PGRP_LOCK(pg);                                          \
 859 } while (0)
 860 #define PGRP_UNLOCK_PGSIGNAL(pg) do {                                   \
 861         if ((pg) != NULL)                                               \
 862                 PGRP_UNLOCK(pg);                                        \
 863 } while (0)
 864
 865 /* Lock and unlock a session. */
 866 #define SESS_LOCK(s)    mtx_lock(&(s)->s_mtx)
 867 #define SESS_UNLOCK(s)  mtx_unlock(&(s)->s_mtx)
 868 #define SESS_LOCKED(s)  mtx_owned(&(s)->s_mtx)
 869 #define SESS_LOCK_ASSERT(s, type)       mtx_assert(&(s)->s_mtx, (type))
 870
 871 /* Hold process U-area in memory, normally for ptrace/procfs work. */
 872 #define PHOLD(p) do {                                                   \
 873         PROC_LOCK(p);                                                   \
 874         _PHOLD(p);                                                      \
 875         PROC_UNLOCK(p);                                                 \
 876 } while (0)
 877 #define _PHOLD(p) do {                                                  \
 878         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 879         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
 880             ("PHOLD of exiting process"));                              \
 881         (p)->p_lock++;                                                  \
 882         if (((p)->p_sflag & PS_INMEM) == 0)                             \
 883                 faultin((p));                                           \
 884 } while (0)
 885
 886 #define PRELE(p) do {                                                   \
 887         PROC_LOCK((p));                                                 \
 888         _PRELE((p));                                                    \
 889         PROC_UNLOCK((p));                                               \
 890 } while (0)
 891 #define _PRELE(p) do {                                                  \
 892         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 893         (--(p)->p_lock);                                                \
 894         if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0)                \
 895                 wakeup(&(p)->p_lock);                                   \
 896 } while (0)
 897
 898 /* Check whether a thread is safe to be swapped out. */
 899 #define thread_safetoswapout(td) (TD_IS_SLEEPING(td) || TD_IS_SUSPENDED(td))
 900
 901 /* Control whether or not it is safe for curthread to sleep. */
 902 #define THREAD_NO_SLEEPING() do {                                       \
 903         KASSERT(!(curthread->td_pflags & TDP_NOSLEEPING),               \
 904             ("nested no sleeping"));                                    \
 905         curthread->td_pflags |= TDP_NOSLEEPING;                         \
 906 } while (0)
 907
 908 #define THREAD_SLEEPING_OK() do {                                       \
 909         KASSERT((curthread->td_pflags & TDP_NOSLEEPING),                \
 910             ("nested sleeping ok"));                                    \
 911         curthread->td_pflags &= ~TDP_NOSLEEPING;                        \
 912 } while (0)
 913
 914 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
 915 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
 916 extern u_long pidhash;
 917
 918 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
 919 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
 920 extern u_long pgrphash;
 921
 922 extern struct sx allproc_lock;
 923 extern struct sx proctree_lock;
 924 extern struct mtx ppeers_lock;
 925 #ifdef KSE
 926 extern struct ksegrp ksegrp0;           /* Primary ksegrp in proc0. */
 927 #endif
 928 extern struct proc proc0;               /* Process slot for swapper. */
 929 extern struct thread thread0;           /* Primary thread in proc0. */
 930 extern struct vmspace vmspace0;         /* VM space for proc0. */
 931 extern int hogticks;                    /* Limit on kernel cpu hogs. */
 932 extern int lastpid;
 933 extern int nprocs, maxproc;             /* Current and max number of procs. */
 934 extern int maxprocperuid;               /* Max procs per uid. */
 935 extern u_long ps_arg_cache_limit;
 936
 937 LIST_HEAD(proclist, proc);
 938 TAILQ_HEAD(procqueue, proc);
 939 TAILQ_HEAD(threadqueue, thread);
 940 extern struct proclist allproc;         /* List of all processes. */
 941 extern struct proclist zombproc;        /* List of zombie processes. */
 942 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
 943
 944 extern struct uma_zone *proc_zone;
 945
 946 struct  proc *pfind(pid_t);             /* Find process by id. */
 947 struct  pgrp *pgfind(pid_t);            /* Find process group by id. */
 948 struct  proc *zpfind(pid_t);            /* Find zombie process by id. */
 949
 950 void    adjustrunqueue(struct thread *, int newpri);
 951 void    ast(struct trapframe *framep);
 952 struct  thread *choosethread(void);
 953 int     cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
 954 int     enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
 955             struct session *sess);
 956 int     enterthispgrp(struct proc *p, struct pgrp *pgrp);
 957 void    faultin(struct proc *p);
 958 void    fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
 959 int     fork1(struct thread *, int, int, struct proc **);
 960 void    fork_exit(void (*)(void *, struct trapframe *), void *,
 961             struct trapframe *);
 962 void    fork_return(struct thread *, struct trapframe *);
 963 int     inferior(struct proc *p);
 964 void    kick_proc0(void);
 965 int     leavepgrp(struct proc *p);
 966 int     maybe_preempt(struct thread *td);
 967 void    mi_switch(int flags, struct thread *newtd);
 968 int     p_candebug(struct thread *td, struct proc *p);
 969 int     p_cansee(struct thread *td, struct proc *p);
 970 int     p_cansched(struct thread *td, struct proc *p);
 971 int     p_cansignal(struct thread *td, struct proc *p, int signum);
 972 int     p_canwait(struct thread *td, struct proc *p);
 973 struct  pargs *pargs_alloc(int len);
 974 void    pargs_drop(struct pargs *pa);
 975 void    pargs_free(struct pargs *pa);
 976 void    pargs_hold(struct pargs *pa);
 977 void    procinit(void);
 978 #ifdef KSE
 979 void    proc_linkup(struct proc *p, struct ksegrp *kg, struct thread *td);
 980 #else
 981 void    proc_linkup(struct proc *p, struct thread *td);
 982 #endif
 983 void    proc_reparent(struct proc *child, struct proc *newparent);
 984 struct  pstats *pstats_alloc(void);
 985 void    pstats_fork(struct pstats *src, struct pstats *dst);
 986 void    pstats_free(struct pstats *ps);
 987 int     securelevel_ge(struct ucred *cr, int level);
 988 int     securelevel_gt(struct ucred *cr, int level);
 989 void    sessrele(struct session *);
 990 void    setrunnable(struct thread *);
 991 void    setrunqueue(struct thread *, int flags);
 992 void    setsugid(struct proc *p);
 993 int     sigonstack(size_t sp);
 994 void    sleepinit(void);
 995 void    stopevent(struct proc *, u_int, u_int);
 996 void    threadinit(void);
 997 void    cpu_idle(void);
 998 extern  void (*cpu_idle_hook)(void);    /* Hook to machdep CPU idler. */
 999 void    cpu_switch(struct thread *old, struct thread *new);
1000 void    cpu_throw(struct thread *old, struct thread *new) __dead2;
1001 void    unsleep(struct thread *);
1002 void    userret(struct thread *, struct trapframe *);
1003
1004 void    cpu_exit(struct thread *);
1005 void    exit1(struct thread *, int) __dead2;
1006 void    cpu_fork(struct thread *, struct proc *, struct thread *, int);
1007 void    cpu_set_fork_handler(struct thread *, void (*)(void *), void *);
1008
1009 /* New in KSE. */
1010 #ifdef KSE
1011 struct  ksegrp *ksegrp_alloc(void);
1012 void    ksegrp_free(struct ksegrp *kg);
1013 void    ksegrp_stash(struct ksegrp *kg);
1014 #endif
1015 void    kse_GC(void);
1016 void    kseinit(void);
1017 void    cpu_set_upcall(struct thread *td, struct thread *td0);
1018 void    cpu_set_upcall_kse(struct thread *, void (*)(void *), void *, stack_t *);
1019 int     cpu_set_user_tls(struct thread *, void *tls_base);
1020 void    cpu_thread_clean(struct thread *);
1021 void    cpu_thread_exit(struct thread *);
1022 void    cpu_thread_setup(struct thread *td);
1023 void    cpu_thread_swapin(struct thread *);
1024 void    cpu_thread_swapout(struct thread *);
1025 #ifdef KSE
1026 void    ksegrp_link(struct ksegrp *kg, struct proc *p);
1027 void    ksegrp_unlink(struct ksegrp *kg);
1028 #endif
1029 struct  thread *thread_alloc(void);
1030 void    thread_continued(struct proc *p);
1031 void    thread_exit(void) __dead2;
1032 int     thread_export_context(struct thread *td, int willexit);
1033 void    thread_free(struct thread *td);
1034 #ifdef KSE
1035 void    thread_link(struct thread *td, struct ksegrp *kg);
1036 #else
1037 void    thread_link(struct thread *td, struct proc *p);
1038 #endif
1039 void    thread_reap(void);
1040 #ifdef KSE
1041 struct thread *thread_schedule_upcall(struct thread *td, struct kse_upcall *ku);
1042 #endif
1043 void    thread_signal_add(struct thread *td, ksiginfo_t *);
1044 int     thread_single(int how);
1045 void    thread_single_end(void);
1046 void    thread_stash(struct thread *td);
1047 int     thread_statclock(int user);
1048 void    thread_stopped(struct proc *p);
1049 void    childproc_stopped(struct proc *child, int reason);
1050 void    childproc_continued(struct proc *child);
1051 void    childproc_exited(struct proc *child);
1052 int     thread_suspend_check(int how);
1053 void    thread_suspend_one(struct thread *td);
1054 struct thread *thread_switchout(struct thread *td, int flags,
1055             struct thread *newtd);
1056 void    thread_unlink(struct thread *td);
1057 void    thread_unsuspend(struct proc *p);
1058 void    thread_unsuspend_one(struct thread *td);
1059 void    thread_unthread(struct thread *td);
1060 #ifdef KSE
1061 int     thread_userret(struct thread *td, struct trapframe *frame);
1062 void    thread_user_enter(struct thread *td);
1063 #endif
1064 void    thread_wait(struct proc *p);
1065 struct thread   *thread_find(struct proc *p, lwpid_t tid);
1066 void    thr_exit1(void);
1067 #ifdef KSE
1068 struct kse_upcall *upcall_alloc(void);
1069 void    upcall_free(struct kse_upcall *ku);
1070 void    upcall_link(struct kse_upcall *ku, struct ksegrp *kg);
1071 void    upcall_unlink(struct kse_upcall *ku);
1072 void    upcall_remove(struct thread *td);
1073 void    upcall_stash(struct kse_upcall *ke);
1074 #endif
1075
1076 #endif  /* _KERNEL */
1077
1078 #endif  /* !_SYS_PROC_H_ */