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  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)proc.h      8.15 (Berkeley) 5/19/95
  39  * $FreeBSD$
  40  */
  41
  42 #ifndef _SYS_PROC_H_
  43 #define _SYS_PROC_H_
  44
  45 #include <sys/callout.h>                /* For struct callout. */
  46 #include <sys/event.h>                  /* For struct klist. */
  47 #include <sys/filedesc.h>
  48 #include <sys/queue.h>
  49 #include <sys/priority.h>
  50 #include <sys/rtprio.h>                 /* XXX */
  51 #include <sys/runq.h>
  52 #include <sys/signal.h>
  53 #ifndef _KERNEL
  54 #include <sys/time.h>                   /* For structs itimerval, timeval. */
  55 #else
  56 #include <sys/pcpu.h>
  57 #endif
  58 #include <sys/ucred.h>
  59 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
  60 #include <vm/uma.h>
  61
  62 /*
  63  * One structure allocated per session.
  64  *
  65  * List of locks
  66  * (m)          locked by s_mtx mtx
  67  * (e)          locked by proctree_lock sx
  68  * (c)          const until freeing
  69  */
  70 struct session {
  71         int             s_count;        /* (m) Ref cnt; pgrps in session. */
  72         struct  proc    *s_leader;      /* (m + e) Session leader. */
  73         struct  vnode   *s_ttyvp;       /* (m) Vnode of controlling tty. */
  74         struct  tty     *s_ttyp;        /* (m) Controlling tty. */
  75         pid_t           s_sid;          /* (c) Session ID. */
  76                                         /* (m) Setlogin() name: */
  77         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
  78         struct  mtx     s_mtx;          /* Mutex to protect members */
  79 };
  80
  81 /*
  82  * One structure allocated per process group.
  83  *
  84  * List of locks
  85  * (m)          locked by pg_mtx mtx
  86  * (e)          locked by proctree_lock sx
  87  * (c)          const until freeing
  88  */
  89 struct pgrp {
  90         LIST_ENTRY(pgrp) pg_hash;       /* (e) Hash chain. */
  91         LIST_HEAD(, proc) pg_members;   /* (m + e) Pointer to pgrp members. */
  92         struct session  *pg_session;    /* (c) Pointer to session. */
  93         struct sigiolst pg_sigiolst;    /* (m) List of sigio sources. */
  94         pid_t           pg_id;          /* (c) Pgrp id. */
  95         int             pg_jobc;        /* (m) job cntl proc count */
  96         struct  mtx     pg_mtx;         /*  Mutex to protect members */
  97 };
  98
  99 struct procsig {
 100         sigset_t ps_sigignore;          /* Signals being ignored. */
 101         sigset_t ps_sigcatch;           /* Signals being caught by user. */
 102         int      ps_flag;
 103         struct   sigacts *ps_sigacts;   /* Signal actions, state. */
 104         int      ps_refcnt;
 105 };
 106
 107 #define PS_NOCLDWAIT    0x0001  /* No zombies if child dies */
 108 #define PS_NOCLDSTOP    0x0002  /* No SIGCHLD when children stop. */
 109 #define PS_CLDSIGIGN    0x0004  /* The SIGCHLD handler is SIG_IGN. */
 110
 111 /*
 112  * pargs, used to hold a copy of the command line, if it had a sane length.
 113  */
 114 struct pargs {
 115         u_int   ar_ref;         /* Reference count. */
 116         u_int   ar_length;      /* Length. */
 117         u_char  ar_args[];      /* Arguments. */
 118 };
 119
 120 /*-
 121  * Description of a process.
 122  *
 123  * This structure contains the information needed to manage a thread of
 124  * control, known in UN*X as a process; it has references to substructures
 125  * containing descriptions of things that the process uses, but may share
 126  * with related processes.  The process structure and the substructures
 127  * are always addressable except for those marked "(CPU)" below,
 128  * which might be addressable only on a processor on which the process
 129  * is running.
 130  *
 131  * Below is a key of locks used to protect each member of struct proc.  The
 132  * lock is indicated by a reference to a specific character in parens in the
 133  * associated comment.
 134  *      * - not yet protected
 135  *      a - only touched by curproc or parent during fork/wait
 136  *      b - created at fork, never changes
 137  *              (exception aiods switch vmspaces, but they are also
 138  *              marked 'P_SYSTEM' so hopefully it will be left alone)
 139  *      c - locked by proc mtx
 140  *      d - locked by allproc_lock lock
 141  *      e - locked by proctree_lock lock
 142  *      f - session mtx
 143  *      g - process group mtx
 144  *      h - callout_lock mtx
 145  *      i - by curproc or the master session mtx
 146  *      j - locked by sched_lock mtx
 147  *      k - only accessed by curthread
 148  *      l - the attaching proc or attaching proc parent
 149  *      m - Giant
 150  *      n - not locked, lazy
 151  *      o - ktrace lock
 152  *      p - select lock (sellock)
 153  *
 154  * If the locking key specifies two identifiers (for example, p_pptr) then
 155  * either lock is sufficient for read access, but both locks must be held
 156  * for write access.
 157  */
 158 struct ithd;
 159 struct nlminfo;
 160 struct trapframe;
 161
 162 /*
 163  * Here we define the four structures used for process information.
 164  *
 165  * The first is the thread. It might be though of as a "Kernel
 166  * Schedulable Entity Context".
 167  * This structure contains all the information as to where a thread of
 168  * execution is now, or was when it was suspended, why it was suspended,
 169  * and anything else that will be needed to restart it when it is
 170  * rescheduled. Always associated with a KSE when running, but can be
 171  * reassigned to an equivalent KSE  when being restarted for
 172  * load balancing. Each of these is associated with a kernel stack
 173  * and a pcb.
 174  *
 175  * It is important to remember that a particular thread structure only
 176  * exists as long as the system call or kernel entrance (e.g. by pagefault)
 177  * which it is currently executing. It should threfore NEVER be referenced
 178  * by pointers in long lived structures that live longer than a single
 179  * request. If several threads complete their work at the same time,
 180  * they will all rewind their stacks to the user boundary, report their
 181  * completion state, and all but one will be freed. That last one will
 182  * be kept to provide a kernel stack and pcb for the NEXT syscall or kernel
 183  * entrance. (basically to save freeing and then re-allocating it) The KSE
 184  * keeps a cached thread available to allow it to quickly
 185  * get one when it needs a new one. There is also a system
 186  * cache of free threads. Threads have priority and partake in priority
 187  * inherritance schemes.
 188  */
 189 struct thread;
 190
 191 /*
 192  * The second structure is the Kernel Schedulable Entity. (KSE)
 193  * It represents the ability to take a slot in the scheduler queue.
 194  * As long as this is scheduled, it could continue to run any threads that
 195  * are assigned to the KSEGRP (see later) until either it runs out
 196  * of runnable threads of high enough priority, or CPU.
 197  * It runs on one CPU and is assigned a quantum of time. When a thread is
 198  * blocked, The KSE continues to run and will search for another thread
 199  * in a runnable state amongst those it has. It May decide to return to user
 200  * mode with a new 'empty' thread if there are no runnable threads.
 201  * Threads are temporarily associated with a KSE for scheduling reasons.
 202  */
 203 struct kse;
 204
 205 /*
 206  * The KSEGRP is allocated resources across a number of CPUs.
 207  * (Including a number of CPUxQUANTA. It parcels these QUANTA up among
 208  * Its KSEs, each of which should be running in a different CPU.
 209  * BASE priority and total available quanta are properties of a KSEGRP.
 210  * Multiple KSEGRPs in a single process compete against each other
 211  * for total quanta in the same way that a forked child competes against
 212  * it's parent process.
 213  */
 214 struct ksegrp;
 215
 216 /*
 217  * A process is the owner of all system resources allocated to a task
 218  * except CPU quanta.
 219  * All KSEGs under one process see, and have the same access to, these
 220  * resources (e.g. files, memory, sockets, permissions kqueues).
 221  * A process may compete for CPU cycles on the same basis as a
 222  * forked process cluster by spawning several KSEGRPs.
 223  */
 224 struct proc;
 225
 226 /***************
 227  * In pictures:
 228  With a single run queue used by all processors:
 229
 230  RUNQ: --->KSE---KSE--...               SLEEPQ:[]---THREAD---THREAD---THREAD
 231            |   /                               []---THREAD
 232            KSEG---THREAD--THREAD--THREAD       []
 233                                                []---THREAD---THREAD
 234
 235   (processors run THREADs from the KSEG until they are exhausted or
 236   the KSEG exhausts its quantum)
 237
 238 With PER-CPU run queues:
 239 KSEs on the separate run queues directly
 240 They would be given priorities calculated from the KSEG.
 241
 242  *
 243  *****************/
 244
 245 /*
 246  * Kernel runnable context (thread).
 247  * This is what is put to sleep and reactivated.
 248  * The first KSE available in the correct group will run this thread.
 249  * If several are available, use the one on the same CPU as last time.
 250  * When waing to be run, threads are hung off the KSEGRP in priority order.
 251  * with N runnable and queued KSEs in the KSEGRP, the first N threads
 252  * are linked to them. Other threads are not yet assigned.
 253  */
 254 struct thread {
 255         struct proc     *td_proc;       /* Associated process. */
 256         struct ksegrp   *td_ksegrp;     /* Associated KSEG. */
 257         TAILQ_ENTRY(thread) td_plist;   /* All threads in this proc */
 258         TAILQ_ENTRY(thread) td_kglist;  /* All threads in this ksegrp */
 259
 260         /* The two queues below should someday be merged */
 261         TAILQ_ENTRY(thread) td_slpq;    /* (j) Sleep queue. XXXKSE */
 262         TAILQ_ENTRY(thread) td_blkq;    /* (j) Mutex queue. XXXKSE */
 263         TAILQ_ENTRY(thread) td_runq;    /* (j) Run queue(s). XXXKSE */
 264
 265         TAILQ_HEAD(, selinfo) td_selq;  /* (p) List of selinfos. */
 266
 267 /* Cleared during fork1() or thread_sched_upcall() */
 268 #define td_startzero td_flags
 269         int             td_flags;       /* (j) TDF_* flags. */
 270         struct kse      *td_last_kse;   /* Where it wants to be if possible. */
 271         struct kse      *td_kse;        /* Current KSE if running. */
 272         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
 273         void            *td_wchan;      /* (j) Sleep address. */
 274         const char      *td_wmesg;      /* (j) Reason for sleep. */
 275         u_char          td_lastcpu;     /* (j) Last cpu we were on. */
 276         u_char          td_inktr;       /* (k) Currently handling a KTR. */
 277         u_char          td_inktrace;    /* (k) Currently handling a KTRACE. */
 278         short           td_locks;       /* (k) DEBUG: lockmgr count of locks */
 279         struct mtx      *td_blocked;    /* (j) Mutex process is blocked on. */
 280         struct ithd     *td_ithd;       /* (b) For interrupt threads only. */
 281         const char      *td_mtxname;    /* (j) Name of mutex blocked on. */
 282         LIST_HEAD(, mtx) td_contested;  /* (j) Contested locks. */
 283         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
 284         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
 285         void            *td_mailbox;    /* the userland mailbox address */
 286         struct ucred    *td_ucred;      /* (k) Reference to credentials. */
 287         void            (*td_switchin)(void); /* (k) switchin special func */
 288         u_int           td_critnest;    /* (k) Critical section nest level. */
 289 #define td_endzero td_md
 290
 291 /* Copied during fork1() or thread_sched_upcall() */
 292 #define td_startcopy td_endzero
 293         /* XXXKSE just copying td_md needs checking! */
 294         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
 295         u_char          td_base_pri;    /* (j) Thread base kernel priority. */
 296         u_char          td_priority;    /* (j) Thread active priority. */
 297 #define td_endcopy td_pcb
 298
 299 /*
 300  * fields that must be manually set in fork1() or thread_sched_upcall()
 301  * or already have been set in the allocator, contstructor, etc..
 302  */
 303         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
 304         enum {
 305                 TDS_NEW = 0x20,
 306                 TDS_UNQUEUED,
 307                 TDS_SLP,
 308                 TDS_MTX,
 309                 TDS_RUNQ,
 310                 TDS_RUNNING,
 311                 TDS_SUSPENDED,          /* would have liked to have run */
 312                 TDS_IWAIT,
 313                 TDS_SURPLUS,
 314                 TDS_SWAPPED,
 315                 TDS_SUSP_SLP            /* on sleep queue AND suspend queue */
 316         } td_state;
 317         register_t      td_retval[2];   /* (k) Syscall aux returns. */
 318         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
 319         struct trapframe *td_frame;     /* (k) */
 320         struct vm_object *td_kstack_obj;/* (a) Kstack object. */
 321         vm_offset_t     td_kstack;      /* Kernel VA of kstack. */
 322 };
 323 /* flags kept in td_flags */
 324 #define TDF_UNBOUND     0x000001 /* may give away the kse, uses the kg runq */
 325 #define TDF_INPANIC     0x000002 /* Caused a panic, let it drive crashdump */
 326 #define TDF_SINTR       0x000008 /* Sleep is interruptible. */
 327 #define TDF_TIMEOUT     0x000010 /* Timing out during sleep. */
 328 #define TDF_SELECT      0x000040 /* Selecting; wakeup/waiting danger. */
 329 #define TDF_CVWAITQ     0x000080 /* Thread is on a cv_waitq (not slpq). */
 330 #define TDF_UPCALLING   0x000100 /* This thread is doing an upcall. */
 331 #define TDF_INMSLEEP    0x000400 /* Don't recurse in msleep() */
 332 #define TDF_TIMOFAIL    0x001000 /* Timeout from sleep after we were awake. */
 333 #define TDF_DEADLKTREAT 0x800000 /* Lock aquisition - deadlock treatment. */
 334
 335 /*
 336  * Traps for young players:
 337  * The main thread flag that controls whether a thread acts as a threaded
 338  * or unthreaded thread is the TDF_UNBOUND flag.
 339  * UPCALLS run with the UNBOUND flags clear, after they are first scheduled.
 340  * i.e. they bind themselves to whatever thread thay are first scheduled with.
 341  * You may see BOUND threads in KSE processes but you should never see
 342  * UNBOUND threads in non KSE processes.
 343  */
 344
 345 /*
 346  * The schedulable entity that can be given a context to run.
 347  * A process may have several of these. Probably one per processor
 348  * but posibly a few more. In this universe they are grouped
 349  * with a KSEG that contains the priority and niceness
 350  * for the group.
 351  */
 352 struct kse {
 353         struct proc     *ke_proc;       /* Associated process. */
 354         struct ksegrp   *ke_ksegrp;     /* Associated KSEG. */
 355         TAILQ_ENTRY(kse) ke_kglist;     /* Queue of all KSEs in ke_ksegrp. */
 356         TAILQ_ENTRY(kse) ke_kgrlist;    /* Queue of all KSEs in this state. */
 357         TAILQ_ENTRY(kse) ke_procq;      /* (j) Run queue. */
 358
 359 #define ke_startzero ke_flags
 360         int             ke_flags;       /* (j) KEF_* flags. */
 361         struct thread   *ke_thread;     /* Active associated thread. */
 362         struct thread   *ke_bound;      /* Thread bound to this KSE (*) */
 363         int             ke_cpticks;     /* (j) Ticks of cpu time. */
 364         fixpt_t         ke_pctcpu;      /* (j) %cpu during p_swtime. */
 365         u_int64_t       ke_uu;          /* (j) Previous user time in usec. */
 366         u_int64_t       ke_su;          /* (j) Previous system time in usec. */
 367         u_int64_t       ke_iu;          /* (j) Previous intr time in usec. */
 368         u_int64_t       ke_uticks;      /* (j) Statclock hits in user mode. */
 369         u_int64_t       ke_sticks;      /* (j) Statclock hits in system mode. */
 370         u_int64_t       ke_iticks;      /* (j) Statclock hits in intr. */
 371         u_char          ke_oncpu;       /* (j) Which cpu we are on. */
 372         char            ke_rqindex;     /* (j) Run queue index. */
 373         enum {
 374                 KES_IDLE = 0x10,
 375                 KES_ONRUNQ,
 376                 KES_UNQUEUED, /* in transit */
 377                 KES_THREAD      /* slaved to thread state */
 378         } ke_state;     /* (j) S* process status. */
 379         void            *ke_mailbox;    /* the userland mailbox address */
 380         struct thread   *ke_tdspare;    /* spare thread for upcalls */
 381 #define ke_endzero ke_dummy
 382
 383 #define ke_startcopy ke_endzero
 384         u_char          ke_dummy;       /*   */
 385 #define ke_endcopy ke_mdstorage
 386
 387         void            *ke_upcall;
 388         void            *ke_stackbase;
 389         u_long          ke_stacksize;
 390         void            *ke_mdstorage;  /* where we store the pcb and frame */
 391         struct pcb      *ke_pcb;        /* the pcb saved for the upcalls */
 392         struct trapframe *ke_frame;     /* the upcall trapframe */
 393         void    *mdkse;                 /* eventually you load from this in */
 394                                         /* switch for our extension PCB x86 */
 395 };
 396 /* flags kept in ke_flags */
 397 #define KEF_OWEUPC      0x00002 /* Owe process an addupc() call at next ast. */
 398 #define KEF_IDLEKSE     0x00004 /* A 'Per CPU idle process'.. has one thread */
 399 #define KEF_LOANED      0x00008 /* On loan from the bound thread to another */
 400 #define KEF_USER        0x00200 /* Process is not officially in the kernel */
 401 #define KEF_ASTPENDING  0x00400 /* KSE has a pending ast. */
 402 #define KEF_NEEDRESCHED 0x00800 /* Process needs to yield. */
 403 #define KEF_DIDRUN      0x02000 /* KSE actually ran. */
 404
 405 /*
 406  * (*) A bound KSE with a bound thread in a KSE process may be lent to
 407  * Other threads, as long as those threads do not leave the kernel.
 408  * The other threads must be either exiting, or be unbound with a valid
 409  * mailbox so that they can save their state there rather than going
 410  * to user space. While this happens the real bound thread is still linked
 411  * to the kse via the ke_bound field, and the KSE has its "KEF_LOANED
 412  * flag set.
 413  */
 414
 415 /*
 416  * Kernel-scheduled entity group (KSEG).  The scheduler considers each KSEG to
 417  * be an indivisible unit from a time-sharing perspective, though each KSEG may
 418  * contain multiple KSEs.
 419  */
 420 struct ksegrp {
 421         struct proc     *kg_proc;       /* Process that contains this KSEG. */
 422         TAILQ_ENTRY(ksegrp) kg_ksegrp;  /* Queue of KSEGs in kg_proc. */
 423         TAILQ_HEAD(, kse) kg_kseq;      /* (ke_kglist) All KSEs. */
 424         TAILQ_HEAD(, kse) kg_iq;        /* (ke_kgrlist) Idle KSEs. */
 425         TAILQ_HEAD(, thread) kg_threads;/* (td_kglist) All threads. */
 426         TAILQ_HEAD(, thread) kg_runq;   /* (td_runq) waiting RUNNABLE threads */
 427         TAILQ_HEAD(, thread) kg_slpq;   /* (td_runq) NONRUNNABLE threads. */
 428
 429 #define kg_startzero kg_estcpu
 430         u_int           kg_estcpu;      /* Sum of the same field in KSEs. */
 431         u_int           kg_slptime;     /* (j) How long completely blocked. */
 432         struct thread   *kg_last_assigned; /* Last thread assigned to a KSE */
 433         int             kg_runnable;    /* Num runnable threads on queue. */
 434         int             kg_runq_kses;   /* Num KSEs on runq. */
 435 #define kg_endzero kg_pri_class
 436
 437 #define kg_startcopy    kg_endzero
 438         u_char          kg_pri_class;   /* (j) Scheduling class. */
 439         u_char          kg_user_pri;    /* (j) User pri from estcpu and nice. */
 440         char            kg_nice;        /* (j?/k?) Process "nice" value. */
 441 /*      struct rtprio   kg_rtprio; */   /* (j) Realtime priority. */
 442 #define kg_endcopy kg_numthreads
 443         int             kg_numthreads;  /* Num threads in total */
 444         int             kg_idle_kses;   /* num KSEs idle */
 445         int             kg_kses;        /* Num KSEs in group. */
 446 };
 447
 448 /*
 449  * The old fashionned process. May have multiple threads, KSEGRPs
 450  * and KSEs. Starts off with a single embedded KSEGRP, KSE and THREAD.
 451  */
 452 struct proc {
 453         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
 454         TAILQ_HEAD(, ksegrp) p_ksegrps; /* (kg_ksegrp) All KSEGs. */
 455         TAILQ_HEAD(, thread) p_threads; /* (td_plist) Threads. (shortcut) */
 456         TAILQ_HEAD(, thread) p_suspended; /* (td_runq) suspended threads */
 457         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
 458         struct filedesc *p_fd;          /* (b) Ptr to open files structure. */
 459                                         /* Accumulated stats for all KSEs? */
 460         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
 461         struct plimit   *p_limit;       /* (m) Process limits. */
 462         struct vm_object *p_upages_obj; /* (a) Upages object. */
 463         struct procsig  *p_procsig;     /* (c) Signal actions, state (CPU). */
 464
 465         struct ksegrp   p_ksegrp;
 466         struct kse      p_kse;
 467
 468         /*
 469          * The following don't make too much sense..
 470          * See the td_ or ke_ versions of the same flags
 471          */
 472         int             p_flag;         /* (c) P_* flags. */
 473         int             p_sflag;        /* (j) PS_* flags. */
 474         enum {
 475                 PRS_NEW = 0,    /* In creation */
 476                 PRS_NORMAL,     /* KSEs can be run */
 477                 PRS_WAIT,       /* Waiting on interrupt ? */
 478                 PRS_ZOMBIE
 479         } p_state;              /* (j) S* process status. */
 480         pid_t           p_pid;          /* (b) Process identifier. */
 481         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
 482         LIST_ENTRY(proc) p_pglist;      /* (g + e) List of processes in pgrp. */
 483         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
 484         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
 485         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
 486         struct mtx      p_mtx;          /* (k) Lock for this struct. */
 487
 488 /* The following fields are all zeroed upon creation in fork. */
 489 #define p_startzero     p_oppid
 490         pid_t           p_oppid;        /* (c + e) Save ppid in ptrace. XXX */
 491         struct vmspace  *p_vmspace;     /* (b) Address space. */
 492         u_int           p_swtime;       /* (j) Time swapped in or out. */
 493         struct itimerval p_realtimer;   /* (h?/k?) Alarm timer. */
 494         struct bintime  p_runtime;      /* (j) Real time. */
 495         int             p_traceflag;    /* (o) Kernel trace points. */
 496         struct vnode    *p_tracep;      /* (c + o) Trace to vnode. */
 497         sigset_t        p_siglist;      /* (c) Sigs arrived, not delivered. */
 498         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
 499         char            p_lock;         /* (c) Proclock (prevent swap) count. */
 500         struct klist p_klist;           /* (c) Knotes attached to this proc. */
 501         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
 502         int             p_sigparent;    /* (c) Signal to parent on exit. */
 503         sigset_t        p_oldsigmask;   /* (c) Saved mask from pre sigpause. */
 504         int             p_sig;          /* (n) For core dump/debugger XXX. */
 505         u_long          p_code;         /* (n) For core dump/debugger XXX. */
 506         u_int           p_stops;        /* (c) Stop event bitmask. */
 507         u_int           p_stype;        /* (c) Stop event type. */
 508         char            p_step;         /* (c) Process is stopped. */
 509         u_char          p_pfsflags;     /* (c) Procfs flags. */
 510         struct nlminfo  *p_nlminfo;     /* (?) Only used by/for lockd. */
 511         void            *p_aioinfo;     /* (c) ASYNC I/O info. */
 512         struct thread   *p_singlethread;/* (j) If single threading this is it */
 513         int             p_suspcount;    /* (j) # threads in suspended mode */
 514         int             p_userthreads;  /* (j) # threads in userland */
 515 /* End area that is zeroed on creation. */
 516 #define p_endzero       p_sigmask
 517
 518 /* The following fields are all copied upon creation in fork. */
 519 #define p_startcopy     p_endzero
 520         sigset_t        p_sigmask;      /* (c) Current signal mask. */
 521         stack_t         p_sigstk;       /* (c) Stack ptr and on-stack flag. */
 522         int             p_magic;        /* (b) Magic number. */
 523         char            p_comm[MAXCOMLEN + 1];  /* (b) Process name. */
 524         struct pgrp     *p_pgrp;        /* (c + e) Pointer to process group. */
 525         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
 526         struct pargs    *p_args;        /* (c) Process arguments. */
 527 /* End area that is copied on creation. */
 528 #define p_endcopy       p_xstat
 529
 530         u_short         p_xstat;        /* (c) Exit status; also stop sig. */
 531         int             p_numthreads;   /* (?) number of threads */
 532         int             p_numksegrps;   /* (?) number of ksegrps */
 533         struct mdproc   p_md;           /* (c) Any machine-dependent fields. */
 534         struct callout  p_itcallout;    /* (h) Interval timer callout. */
 535         struct user     *p_uarea;       /* (k) Kernel VA of u-area (CPU) */
 536         u_short         p_acflag;       /* (c) Accounting flags. */
 537         struct rusage   *p_ru;          /* (a) Exit information. XXX */
 538         struct proc     *p_peers;       /* (c) */
 539         struct proc     *p_leader;      /* (b) */
 540         void            *p_emuldata;    /* (c) Emulator state data. */
 541 };
 542
 543 #define p_rlimit        p_limit->pl_rlimit
 544 #define p_sigacts       p_procsig->ps_sigacts
 545 #define p_sigignore     p_procsig->ps_sigignore
 546 #define p_sigcatch      p_procsig->ps_sigcatch
 547 #define p_session       p_pgrp->pg_session
 548 #define p_pgid          p_pgrp->pg_id
 549
 550 #define NOCPU   0xff            /* For p_oncpu when we aren't on a CPU. */
 551
 552 /* Status values (p_stat). */
 553
 554 /* These flags are kept in p_flag. */
 555 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
 556 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
 557 #define P_KTHREAD       0x00004 /* Kernel thread. (*)*/
 558 #define P_NOLOAD        0x00008 /* Ignore during load avg calculations. */
 559 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
 560 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
 561 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
 562 #define P_WAITED        0x01000 /* Someone is waiting for us */
 563 #define P_WEXIT         0x02000 /* Working on exiting. */
 564 #define P_EXEC          0x04000 /* Process called exec. */
 565 #define P_KSES          0x08000 /* Process is using KSEs. */
 566 #define P_CONTINUED     0x10000 /* Proc has continued from a stopped state. */
 567
 568 /* flags that control how threads may be suspended for some reason */
 569 #define P_STOPPED_SIG           0x20000 /* Stopped due to SIGSTOP/SIGTSTP */
 570 #define P_STOPPED_TRACE         0x40000 /* Stopped because of tracing */
 571 #define P_STOPPED_SINGLE        0x80000 /* Only one thread can continue */
 572                                         /* (not to user) */
 573 #define P_SINGLE_EXIT           0x00400 /* Threads suspending should exit, */
 574                                         /* not wait */
 575 #define P_TRACED                0x00800 /* Debugged process being traced. */
 576 #define P_STOPPED               (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
 577 #define P_SHOULDSTOP(p)         ((p)->p_flag & P_STOPPED)
 578
 579 /* Should be moved to machine-dependent areas. */
 580 #define P_UNUSED100000  0x100000
 581 #define P_COWINPROGRESS 0x400000 /* Snapshot copy-on-write in progress. */
 582
 583 #define P_JAILED        0x1000000 /* Process is in jail. */
 584 #define P_OLDMASK       0x2000000 /* Need to restore mask after suspend. */
 585 #define P_ALTSTACK      0x4000000 /* Have alternate signal stack. */
 586 #define P_INEXEC        0x8000000 /* Process is in execve(). */
 587
 588 /* These flags are kept in p_sflag and are protected with sched_lock. */
 589 #define PS_INMEM        0x00001 /* Loaded into memory. */
 590 #define PS_PROFIL       0x00004 /* Has started profiling. */
 591 #define PS_ALRMPEND     0x00020 /* Pending SIGVTALRM needs to be posted. */
 592 #define PS_PROFPEND     0x00040 /* Pending SIGPROF needs to be posted. */
 593 #define PS_SWAPINREQ    0x00100 /* Swapin request due to wakeup. */
 594 #define PS_SWAPPING     0x00200 /* Process is being swapped. */
 595 #define PS_NEEDSIGCHK   0x02000 /* Process may need signal delivery. */
 596 #define PS_SWAPPINGIN   0x04000 /* Swapin in progress. */
 597
 598 /* used only in legacy conversion code */
 599 #define SIDL    1               /* Process being created by fork. */
 600 #define SRUN    2               /* Currently runnable. */
 601 #define SSLEEP  3               /* Sleeping on an address. */
 602 #define SSTOP   4               /* Process debugging or suspension. */
 603 #define SZOMB   5               /* Awaiting collection by parent. */
 604 #define SWAIT   6               /* Waiting for interrupt. */
 605 #define SMTX    7               /* Blocked on a mutex. */
 606
 607 #define P_MAGIC         0xbeefface
 608
 609 #ifdef _KERNEL
 610
 611 #ifdef MALLOC_DECLARE
 612 MALLOC_DECLARE(M_PARGS);
 613 MALLOC_DECLARE(M_PGRP);
 614 MALLOC_DECLARE(M_SESSION);
 615 MALLOC_DECLARE(M_SUBPROC);
 616 MALLOC_DECLARE(M_ZOMBIE);
 617 #endif
 618
 619 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
 620         LIST_FOREACH((p), &allproc, p_list)
 621 #define FOREACH_KSEGRP_IN_PROC(p, kg)                                   \
 622         TAILQ_FOREACH((kg), &(p)->p_ksegrps, kg_ksegrp)
 623 #define FOREACH_THREAD_IN_GROUP(kg, td)                                 \
 624         TAILQ_FOREACH((td), &(kg)->kg_threads, td_kglist)
 625 #define FOREACH_KSE_IN_GROUP(kg, ke)                                    \
 626         TAILQ_FOREACH((ke), &(kg)->kg_kseq, ke_kglist)
 627 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
 628         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
 629
 630 /* XXXKSE the lines below should probably only be used in 1:1 code */
 631 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&p->p_threads)
 632 #define FIRST_KSEGRP_IN_PROC(p) TAILQ_FIRST(&p->p_ksegrps)
 633 #define FIRST_KSE_IN_KSEGRP(kg) TAILQ_FIRST(&kg->kg_kseq)
 634 #define FIRST_KSE_IN_PROC(p) FIRST_KSE_IN_KSEGRP(FIRST_KSEGRP_IN_PROC(p))
 635
 636 static __inline int
 637 sigonstack(size_t sp)
 638 {
 639         register struct thread *td = curthread;
 640         struct proc *p = td->td_proc;
 641
 642         return ((p->p_flag & P_ALTSTACK) ?
 643 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
 644             ((p->p_sigstk.ss_size == 0) ? (p->p_sigstk.ss_flags & SS_ONSTACK) :
 645                 ((sp - (size_t)p->p_sigstk.ss_sp) < p->p_sigstk.ss_size))
 646 #else
 647             ((sp - (size_t)p->p_sigstk.ss_sp) < p->p_sigstk.ss_size)
 648 #endif
 649             : 0);
 650 }
 651
 652 /* Handy macro to determine if p1 can mangle p2. */
 653 #define PRISON_CHECK(p1, p2) \
 654         ((p1)->p_prison == NULL || (p1)->p_prison == (p2)->p_prison)
 655
 656 /*
 657  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
 658  * as it is used to represent "no process group".
 659  */
 660 #define PID_MAX         99999
 661 #define NO_PID          100000
 662
 663 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
 664 #define SESSHOLD(s)     ((s)->s_count++)
 665 #define SESSRELE(s) {                                                   \
 666         if (--(s)->s_count == 0)                                        \
 667                 FREE(s, M_SESSION);                                     \
 668 }
 669
 670 #define STOPEVENT(p, e, v) do {                                         \
 671         PROC_LOCK(p);                                                   \
 672         _STOPEVENT((p), (e), (v));                                      \
 673         PROC_UNLOCK(p);                                                 \
 674 } while (0)
 675 #define _STOPEVENT(p, e, v) do {                                        \
 676         PROC_LOCK_ASSERT(p, MA_OWNED);                                  \
 677         if ((p)->p_stops & (e)) {                                       \
 678                 stopevent((p), (e), (v));                               \
 679         }                                                               \
 680 } while (0)
 681
 682 /* Lock and unlock a process. */
 683 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
 684 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
 685 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
 686 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
 687 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
 688
 689 /* Lock and unlock a process group. */
 690 #define PGRP_LOCK(pg)   mtx_lock(&(pg)->pg_mtx)
 691 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
 692 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
 693 #define PGRP_LOCK_ASSERT(pg, type)      mtx_assert(&(pg)->pg_mtx, (type))
 694
 695 #define PGRP_LOCK_PGSIGNAL(pg)                                          \
 696         do {                                                            \
 697                 if ((pg) != NULL)                                       \
 698                         PGRP_LOCK(pg);                                  \
 699         } while (0);
 700
 701 #define PGRP_UNLOCK_PGSIGNAL(pg)                                        \
 702         do {                                                            \
 703                 if ((pg) != NULL)                                       \
 704                         PGRP_UNLOCK(pg);                                \
 705         } while (0);
 706
 707 /* Lock and unlock a session. */
 708 #define SESS_LOCK(s)    mtx_lock(&(s)->s_mtx)
 709 #define SESS_UNLOCK(s)  mtx_unlock(&(s)->s_mtx)
 710 #define SESS_LOCKED(s)  mtx_owned(&(s)->s_mtx)
 711 #define SESS_LOCK_ASSERT(s, type)       mtx_assert(&(s)->s_mtx, (type))
 712
 713 /* Hold process U-area in memory, normally for ptrace/procfs work. */
 714 #define PHOLD(p) do {                                                   \
 715         PROC_LOCK(p);                                                   \
 716         _PHOLD(p);                                                      \
 717         PROC_UNLOCK(p);                                                 \
 718 } while (0)
 719 #define _PHOLD(p) do {                                                  \
 720         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 721         if ((p)->p_lock++ == 0) {                                       \
 722                 mtx_lock_spin(&sched_lock);                             \
 723                 faultin((p));                                           \
 724                 mtx_unlock_spin(&sched_lock);                           \
 725         }                                                               \
 726 } while (0)
 727
 728 #define PRELE(p) do {                                                   \
 729         PROC_LOCK((p));                                                 \
 730         _PRELE((p));                                                    \
 731         PROC_UNLOCK((p));                                               \
 732 } while (0)
 733 #define _PRELE(p) do {                                                  \
 734         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
 735         (--(p)->p_lock);                                                \
 736 } while (0)
 737
 738 /* Check whether a thread is safe to be swapped out. */
 739 #define thread_safetoswapout(td)                \
 740                 ((td)->td_state == TDS_RUNQ ||  \
 741                  (td)->td_state == TDS_SLP)
 742
 743 /* Lock and unlock process arguments. */
 744 #define PARGS_LOCK(p)           mtx_lock(&pargs_ref_lock)
 745 #define PARGS_UNLOCK(p)         mtx_unlock(&pargs_ref_lock)
 746
 747 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
 748 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
 749 extern u_long pidhash;
 750
 751 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
 752 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
 753 extern u_long pgrphash;
 754
 755 extern struct sx allproc_lock;
 756 extern struct sx proctree_lock;
 757 extern struct mtx pargs_ref_lock;
 758 extern struct proc proc0;               /* Process slot for swapper. */
 759 extern struct thread thread0;           /* Primary thread in proc0 */
 760 extern int hogticks;                    /* Limit on kernel cpu hogs. */
 761 extern int nprocs, maxproc;             /* Current and max number of procs. */
 762 extern int maxprocperuid;               /* Max procs per uid. */
 763 extern u_long ps_arg_cache_limit;
 764 extern int ps_argsopen;
 765 extern int ps_showallprocs;
 766 extern int sched_quantum;               /* Scheduling quantum in ticks. */
 767
 768 LIST_HEAD(proclist, proc);
 769 TAILQ_HEAD(procqueue, proc);
 770 TAILQ_HEAD(threadqueue, thread);
 771 extern struct proclist allproc;         /* List of all processes. */
 772 extern struct proclist zombproc;        /* List of zombie processes. */
 773 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
 774 extern struct proc *updateproc;         /* Process slot for syncer (sic). */
 775
 776 extern uma_zone_t proc_zone;
 777
 778 extern int lastpid;
 779
 780 /*
 781  * XXX macros for scheduler.  Shouldn't be here, but currently needed for
 782  * bounding the dubious p_estcpu inheritance in wait1().
 783  * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in
 784  * the range 100-256 Hz (approximately).
 785  */
 786 #define ESTCPULIM(e) \
 787     min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * (PRIO_MAX - PRIO_MIN) - \
 788              RQ_PPQ) + INVERSE_ESTCPU_WEIGHT - 1)
 789 #define INVERSE_ESTCPU_WEIGHT   8       /* 1 / (priorities per estcpu level). */
 790 #define NICE_WEIGHT     1               /* Priorities per nice level. */
 791
 792 struct  proc *pfind(pid_t);     /* Find process by id. */
 793 struct  pgrp *pgfind(pid_t);    /* Find process group by id. */
 794 struct  proc *zpfind(pid_t);    /* Find zombie process by id. */
 795
 796 void    ast(struct trapframe *framep);
 797 struct  thread *choosethread(void);
 798 int     cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
 799 int     enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp, struct session *sess);
 800 int     enterthispgrp(struct proc *p, struct pgrp *pgrp);
 801 void    faultin(struct proc *p);
 802 void    fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
 803 int     fork1(struct thread *, int, struct proc **);
 804 void    fork_exit(void (*)(void *, struct trapframe *), void *,
 805             struct trapframe *);
 806 void    fork_return(struct thread *, struct trapframe *);
 807 int     inferior(struct proc *p);
 808 int     leavepgrp(struct proc *p);
 809 void    mi_switch(void);
 810 int     p_candebug(struct thread *td, struct proc *p);
 811 int     p_cansee(struct thread *td, struct proc *p);
 812 int     p_cansched(struct thread *td, struct proc *p);
 813 int     p_cansignal(struct thread *td, struct proc *p, int signum);
 814 struct  pargs *pargs_alloc(int len);
 815 void    pargs_drop(struct pargs *pa);
 816 void    pargs_free(struct pargs *pa);
 817 void    pargs_hold(struct pargs *pa);
 818 void    procinit(void);
 819 void    threadinit(void);
 820 void    proc_linkup(struct proc *p, struct ksegrp *kg,
 821             struct kse *ke, struct thread *td);
 822 void    proc_reparent(struct proc *child, struct proc *newparent);
 823 void    remrunqueue(struct thread *);
 824 void    resetpriority(struct ksegrp *);
 825 int     roundrobin_interval(void);
 826 void    schedclock(struct thread *);
 827 int     securelevel_ge(struct ucred *cr, int level);
 828 int     securelevel_gt(struct ucred *cr, int level);
 829 void    setrunnable(struct thread *);
 830 void    setrunqueue(struct thread *);
 831 void    setsugid(struct proc *p);
 832 void    sleepinit(void);
 833 void    stopevent(struct proc *, u_int, u_int);
 834 void    cpu_idle(void);
 835 void    cpu_switch(void);
 836 void    cpu_throw(void) __dead2;
 837 void    unsleep(struct thread *);
 838 void    updatepri(struct ksegrp *);
 839 void    userret(struct thread *, struct trapframe *, u_int);
 840 void    maybe_resched(struct thread *);
 841
 842 void    cpu_exit(struct thread *);
 843 void    cpu_sched_exit(struct thread *);
 844 void    exit1(struct thread *, int) __dead2;
 845 void    cpu_fork(struct thread *, struct proc *, struct thread *, int);
 846 void    cpu_set_fork_handler(struct thread *, void (*)(void *), void *);
 847 void    cpu_wait(struct proc *);
 848
 849 /* New in KSE. */
 850 struct  thread *thread_alloc(void);
 851 void    thread_free(struct thread *td);
 852 int     cpu_export_context(struct thread *td);
 853 void    cpu_free_kse_mdstorage(struct kse *kse);
 854 void    cpu_save_upcall(struct thread *td, struct kse *newkse);
 855 void    cpu_set_args(struct thread *, struct kse *);
 856 void    cpu_set_upcall(struct thread *td, void *pcb);
 857 void    cpu_thread_exit(struct thread *);
 858 void    cpu_thread_setup(struct thread *td);
 859 void    kse_reassign(struct kse *ke);
 860 void    kse_link(struct kse *ke, struct ksegrp *kg);
 861 void    ksegrp_link(struct ksegrp *kg, struct proc *p);
 862 int     kserunnable(void);
 863 void    make_kse_runnable(struct kse *ke);
 864 void    thread_exit(void) __dead2;
 865 int     thread_export_context(struct thread *td);
 866 void    thread_link(struct thread *td, struct ksegrp *kg);
 867 void    thread_reap(void);
 868 struct thread *thread_schedule_upcall(struct thread *td, struct kse *ke);
 869 int     thread_single(int how);
 870 #define SINGLE_NO_EXIT 0                        /* values for 'how' */
 871 #define SINGLE_EXIT 1
 872 void    thread_single_end(void);
 873 void    thread_stash(struct thread *td);
 874 int     thread_suspend_check(int how);
 875 void    thread_unsuspend(struct proc *p);
 876 void    thread_suspend_one(struct thread *td);
 877 void    thread_unsuspend_one(struct thread *td);
 878 int     thread_userret(struct proc *p, struct ksegrp *kg, struct kse *ke,
 879             struct thread *td, struct trapframe *frame);
 880
 881 void    thread_sanity_check(struct thread *td);
 882 #endif  /* _KERNEL */
 883
 884 #endif  /* !_SYS_PROC_H_ */