]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/sys/proc.h
This commit was generated by cvs2svn to compensate for changes in r85815,
[FreeBSD/FreeBSD.git] / 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 #endif
56 #include <sys/ucred.h>
57 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
58
59 /*
60  * One structure allocated per session.
61  */
62 struct session {
63         int             s_count;        /* Ref cnt; pgrps in session. */
64         struct proc     *s_leader;      /* Session leader. */
65         struct vnode    *s_ttyvp;       /* Vnode of controlling terminal. */
66         struct tty      *s_ttyp;        /* Controlling terminal. */
67         pid_t           s_sid;          /* Session ID. */
68                                         /* Setlogin() name: */
69         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
70 };
71
72 /*
73  * One structure allocated per process group.
74  */
75 struct pgrp {
76         LIST_ENTRY(pgrp) pg_hash;       /* Hash chain. */
77         LIST_HEAD(, proc) pg_members;   /* Pointer to pgrp members. */
78         struct session  *pg_session;    /* Pointer to session. */
79         struct  sigiolst pg_sigiolst;   /* List of sigio sources. */
80         pid_t           pg_id;          /* Pgrp id. */
81         int             pg_jobc;        /* # procs qualifying pgrp for job control */
82 };
83
84 struct procsig {
85         sigset_t ps_sigignore;  /* Signals being ignored. */
86         sigset_t ps_sigcatch;   /* Signals being caught by user. */
87         int      ps_flag;
88         struct   sigacts *ps_sigacts;   /* Signal actions, state. */
89         int      ps_refcnt;
90 };
91
92 #define PS_NOCLDWAIT    0x0001  /* No zombies if child dies */
93 #define PS_NOCLDSTOP    0x0002  /* No SIGCHLD when children stop. */
94
95 /*
96  * pargs, used to hold a copy of the command line, if it had a sane length.
97  */
98 struct pargs {
99         u_int   ar_ref;         /* Reference count. */
100         u_int   ar_length;      /* Length. */
101         u_char  ar_args[0];     /* Arguments. */
102 };
103
104 /*-
105  * Description of a process.
106  *
107  * This structure contains the information needed to manage a thread of
108  * control, known in UN*X as a process; it has references to substructures
109  * containing descriptions of things that the process uses, but may share
110  * with related processes.  The process structure and the substructures
111  * are always addressable except for those marked "(CPU)" below,
112  * which might be addressable only on a processor on which the process
113  * is running.
114  *
115  * Below is a key of locks used to protect each member of struct proc.  The
116  * lock is indicated by a reference to a specific character in parens in the
117  * associated comment.
118  *      * - not yet protected
119  *      a - only touched by curproc or parent during fork/wait
120  *      b - created at fork, never changes
121  *              (exception aiods switch vmspaces, but they are also
122  *              marked 'P_SYSTEM' so hopefully it will be left alone)
123  *      c - locked by proc mtx
124  *      d - locked by allproc_lock lock
125  *      e - locked by proctree_lock lock
126  *      f - session mtx
127  *      g - process group mtx
128  *      h - callout_lock mtx
129  *      i - by curproc or the master session mtx
130  *      j - locked by sched_lock mtx
131  *      k - only accessed by curthread
132  *      l - the attaching proc or attaching proc parent
133  *      m - Giant
134  *      n - not locked, lazy
135  *
136  * If the locking key specifies two identifiers (for example, p_pptr) then
137  * either lock is sufficient for read access, but both locks must be held
138  * for write access.
139  */
140 struct ithd;
141 struct nlminfo;
142 struct trapframe;
143
144 /*
145  * Here we define the four structures used for process information.
146  *
147  * The first is the thread. It might be though of as a "Kernel
148  * Schedulable Entity Context".
149  * This structure contains all the information as to where a thread of 
150  * execution is now, or was when it was suspended, why it was suspended,
151  * and anything else that will be needed to restart it when it is
152  * rescheduled. Always associated with a KSE when running, but can be
153  * reassigned to an equivalent KSE  when being restarted for
154  * load balancing. Each of these is associated with a kernel stack
155  * and a pcb.
156  * 
157  * It is important to remember that a particular thread structure only
158  * exists as long as the system call or kernel entrance (e.g. by pagefault)
159  * which it is currently executing. It should threfore NEVER be referenced
160  * by pointers in long lived structures that live longer than a single
161  * request. If several threads complete their work at the same time,
162  * they will all rewind their stacks to the uer boundary, report their
163  * completion state, and all but one will be freed. That last one will
164  * be kept to provide a kernel stack and pcb for the NEXT syscall or kernel
165  * entrance. (basically to save freeing and then re-allocating it) A process
166  * might keep a cache of threads available to allow it to quickly
167  * get one when it needs a new one. There would probably also be a system
168  * cache of free threads.
169  */
170 struct thread;
171
172 /* 
173  * The second structure is the Kernel Schedulable Entity. (KSE)
174  * As long as this is scheduled, it will continue to run any threads that
175  * are assigned to it or the KSEGRP (see later) until either it runs out
176  * of runnable threads or CPU.
177  * It runs on one CPU and is assigned a quantum of time. When a thread is
178  * blocked, The KSE continues to run and will search for another thread
179  * in a runnable state amongst those it has. It May decide to return to user
180  * mode with a new 'empty' thread if there are no runnable threads.
181  * threads are associated with a KSE for cache reasons, but a sheduled KSE with
182  * no runnable thread will try take a thread from a sibling KSE before
183  * surrendering its quantum. In some schemes it gets it's quantum from the KSEG
184  * and contributes to draining that quantum, along withthe other KSEs in
185  * the group. (undecided)
186  */
187 struct kse;
188
189 /*
190  * The KSEGRP is allocated resources across a number of CPUs.
191  * (Including a number of CPUxQUANTA. It parcels these QUANTA up among
192  * Its KSEs, each of which should be running in a different CPU.
193  * Priority and total available sheduled quanta are properties of a KSEGRP.
194  * Multiple KSEGRPs in a single process compete against each other
195  * for total quanta in the same way that a forked child competes against
196  * it's parent process.
197  */
198 struct ksegrp;
199
200 /*
201  * A process is the owner of all system resources allocated to a task
202  * except CPU quanta.
203  * All KSEGs under one process see, and have the same access to, these
204  * resources (e.g. files, memory, sockets, permissions kqueues).
205  * A process may compete for CPU cycles on the same basis as a
206  * forked process cluster by spawning several KSEGRPs. 
207  */
208 struct proc;
209
210 /***************
211  * In pictures:
212  With a single run queue used by all processors:
213
214  RUNQ: --->KSE---KSE--...               SLEEPQ:[]---THREAD---THREAD---THREAD
215            |   /                               []---THREAD
216            KSEG---THREAD--THREAD--THREAD       []
217                                                []---THREAD---THREAD
218
219   (processors run THREADs from the KSEG until they are exhausted or
220   the KSEG exhausts its quantum) 
221
222 With PER-CPU run queues:
223 KSEs on the separate run queues directly
224 They would be given priorities calculated from the KSEG.
225
226  *
227  *****************/
228
229 /*
230  * Kernel runnable context (thread).
231  * This is what is put to sleep and reactivated.
232  * The first KSE available in the correct group will run this thread.
233  * If several are available, use the one on the same CPU as last time.
234  */
235 struct thread {
236         struct proc     *td_proc;       /* Associated process. */
237         struct ksegrp   *td_ksegrp;     /* Associated KSEG. */
238         struct kse      *td_last_kse;   /* Where it wants to be if possible. */
239         struct kse      *td_kse;        /* Current KSE if running. */
240         TAILQ_ENTRY(thread) td_plist;   /* All threads in this proc */
241         TAILQ_ENTRY(thread) td_kglist;  /* All threads in this ksegrp */
242
243         /* The two queues below should someday be merged */
244         TAILQ_ENTRY(thread) td_slpq;    /* (j) Sleep queue. XXXKSE */ 
245         TAILQ_ENTRY(thread) td_blkq;    /* (j) Mutex queue. XXXKSE */ 
246         TAILQ_ENTRY(thread) td_runq;    /* (j) Run queue(s). XXXKSE */ 
247
248 #define td_startzero td_flags
249         int             td_flags;       /* (j) TDF_* flags. */
250         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
251         void            *td_wchan;      /* (j) Sleep address. */
252         const char      *td_wmesg;      /* (j) Reason for sleep. */
253         u_char          td_lastcpu;     /* (j) Last cpu we were on. */
254         short           td_locks;       /* (k) DEBUG: lockmgr count of locks */
255         struct mtx      *td_blocked;    /* (j) Mutex process is blocked on. */
256         struct ithd     *td_ithd;       /* (b) For interrupt threads only. */
257         const char      *td_mtxname;    /* (j) Name of mutex blocked on. */
258         LIST_HEAD(, mtx) td_contested;  /* (j) Contested locks. */
259         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
260         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
261 #define td_endzero td_md
262
263 #define td_startcopy td_endzero
264         /* XXXKSE p_md is in the "on your own" section in old struct proc */
265         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
266         register_t      td_retval[2];   /* (k) Syscall aux returns. */
267 #define td_endcopy td_pcb
268
269         struct ucred    *td_ucred;      /* (k) Reference to credentials. */
270         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
271         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
272         struct trapframe *td_frame;     /* (k) */
273         struct vm_object *td_kstack_obj;/* (a) Kstack object. */
274         vm_offset_t     td_kstack;      /* Kernel VA of kstack. */
275 };
276
277 /*
278  * The schedulable entity that can be given a context to run.
279  * A process may have several of these. Probably one per processor
280  * but posibly a few more. In this universe they are grouped
281  * with a KSEG that contains the priority and niceness
282  * for the group.
283  */
284 struct kse {
285         struct proc     *ke_proc;       /* Associated process. */
286         struct ksegrp   *ke_ksegrp;     /* Associated KSEG. */
287         struct thread   *ke_thread;     /* Associated thread, if running. */
288         TAILQ_ENTRY(kse) ke_kglist;     /* Queue of all KSEs in ke_ksegrp. */
289         TAILQ_ENTRY(kse) ke_kgrlist;    /* Queue of all KSEs in this state. */
290         TAILQ_ENTRY(kse) ke_procq;      /* (j) Run queue. */
291         TAILQ_HEAD(, thread) ke_runq;   /* (td_runq) RUNNABLE bound to KSE. */
292
293 #define ke_startzero ke_flags
294         int             ke_flags;       /* (j) KEF_* flags. */
295         /*u_int         ke_estcpu; */   /* (j) Time averaged val of cpticks. */
296         int             ke_cpticks;     /* (j) Ticks of cpu time. */
297         fixpt_t         ke_pctcpu;      /* (j) %cpu during p_swtime. */
298         u_int64_t       ke_uu;          /* (j) Previous user time in usec. */
299         u_int64_t       ke_su;          /* (j) Previous system time in usec. */
300         u_int64_t       ke_iu;          /* (j) Previous intr time in usec. */
301         u_int64_t       ke_uticks;      /* (j) Statclock hits in user mode. */
302         u_int64_t       ke_sticks;      /* (j) Statclock hits in system mode. */
303         u_int64_t       ke_iticks;      /* (j) Statclock hits in intr. */
304         u_char          ke_oncpu;       /* (j) Which cpu we are on. */
305         u_int           ke_slptime;     /* (j) Time since last idle. */
306         char            ke_rqindex;     /* (j) Run queue index. */
307 #define ke_endzero ke_priority
308
309 #define ke_startcopy ke_endzero
310         u_char          ke_priority;    /* (j) Process priority. */
311         u_char          ke_usrpri;      /* (j) User pri from cpu & nice. */
312 #define ke_endcopy ke_end
313
314         int             ke_end;         /* dummy entry */
315 };
316
317 /*
318  * Kernel-scheduled entity group (KSEG).  The scheduler considers each KSEG to
319  * be an indivisible unit from a time-sharing perspective, though each KSEG may
320  * contain multiple KSEs.
321  */
322 struct ksegrp {
323         struct proc     *kg_proc;       /* Process that contains this KSEG. */
324         TAILQ_ENTRY(ksegrp) kg_ksegrp;  /* Queue of KSEGs in kg_proc. */
325         TAILQ_HEAD(, kse) kg_kseq;      /* (ke_kglist) All KSEs. */
326         TAILQ_HEAD(, kse) kg_rq;        /* (ke_kgrlist) Runnable KSEs. */
327         TAILQ_HEAD(, kse) kg_iq;        /* (ke_kgrlist) Idle KSEs. */
328         TAILQ_HEAD(, thread) kg_threads;/* (td_kglist) All threads. */
329         TAILQ_HEAD(, thread) kg_runq;   /* (td_runq) Unbound RUNNABLE threads */
330         TAILQ_HEAD(, thread) kg_slpq;   /* (td_runq) NONRUNNABLE threads. */
331
332 #define kg_startzero kg_estcpu
333         u_int           kg_slptime;     /* (j) How long completely blocked. */
334         u_int           kg_estcpu;      /* Sum of the same field in KSEs. */
335 #define kg_endzero kg_pri
336
337 #define kg_startcopy    kg_endzero
338         struct priority kg_pri;         /* (j) Process priority. */
339         char            kg_nice;        /* (j?/k?) Process "nice" value. */
340         struct rtprio   kg_rtprio;      /* (j) Realtime priority. */
341 #define kg_endcopy kg_runnable
342
343         int             kg_runnable;    /* Num runnable threads on queue. */
344         int             kg_runq_kses;   /* Num KSEs on runq. */
345         int             kg_kses;        /* Num KSEs in group. */
346 };
347
348 /*
349  * The old fashionned process. May have multiple threads, KSEGRPs
350  * and KSEs. Starts off with a single embedded KSEGRP, KSE and THREAD.
351  */
352 struct proc {
353         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
354         TAILQ_HEAD(, ksegrp) p_ksegrps; /* (kg_ksegrp) All KSEGs. */
355         TAILQ_HEAD(, thread) p_threads; /* (td_plist) Threads. (shortcut) */
356         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
357         struct filedesc *p_fd;          /* (b) Ptr to open files structure. */
358                                         /* Accumulated stats for all KSEs? */
359         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
360         struct plimit   *p_limit;       /* (m) Process limits. */
361         struct vm_object *p_upages_obj; /* (a) Upages object. */
362         struct procsig  *p_procsig;     /* (c) Signal actions, state (CPU). */
363  
364         struct ksegrp   p_ksegrp;
365         struct kse      p_kse;
366         struct thread   p_thread;
367
368         /*
369          * The following don't make too much sense..
370          * See the td_ or ke_ versions of the same flags
371          */
372         int             p_flag;         /* (c) P_* flags. */
373         int             p_sflag;        /* (j) PS_* flags. */
374         int             p_stat;         /* (j) S* process status. */
375
376         pid_t           p_pid;          /* (b) Process identifier. */
377         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
378         LIST_ENTRY(proc) p_pglist;      /* (c) List of processes in pgrp. */
379         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
380         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
381         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
382
383 /* The following fields are all zeroed upon creation in fork. */
384 #define p_startzero     p_oppid
385         pid_t           p_oppid;        /* (c + e) Save ppid in ptrace. XXX */
386         struct vmspace  *p_vmspace;     /* (b) Address space. */
387         u_int           p_swtime;       /* (j) Time swapped in or out. */
388         struct itimerval p_realtimer;   /* (h?/k?) Alarm timer. */
389         u_int64_t       p_runtime;      /* (j) Real time in microsec. */
390         int             p_traceflag;    /* (j?) Kernel trace points. */
391         struct vnode    *p_tracep;      /* (j?) Trace to vnode. */
392         sigset_t        p_siglist;      /* (c) Sigs arrived, not delivered. */
393         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
394         struct mtx      p_mtx;          /* (k) Lock for this struct. */
395         char            p_lock;         /* (c) Proclock (prevent swap) count. */
396         struct klist    p_klist;        /* (c) Knotes attached to this proc. */
397         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
398         int             p_sigparent;    /* (c) Signal to parent on exit. */
399         sigset_t        p_oldsigmask;   /* (c) Saved mask from pre sigpause. */
400         int             p_sig;          /* (n) For core dump/debugger XXX. */
401         u_long          p_code;         /* (n) For core dump/debugger XXX. */
402         u_int           p_stops;        /* (c) Stop event bitmask. */
403         u_int           p_stype;        /* (c) Stop event type. */
404         char            p_step;         /* (c) Process is stopped. */
405         u_char          p_pfsflags;     /* (c) Procfs flags. */
406         struct nlminfo  *p_nlminfo;     /* (?) Only used by/for lockd. */
407         void            *p_aioinfo;     /* (c) ASYNC I/O info. */
408 /* End area that is zeroed on creation. */
409 #define p_startcopy     p_sigmask
410
411 /* The following fields are all copied upon creation in fork. */
412 #define p_endzero       p_startcopy
413         sigset_t        p_sigmask;      /* (c) Current signal mask. */
414         stack_t         p_sigstk;       /* (c) Stack ptr and on-stack flag. */
415         int             p_magic;        /* (b) Magic number. */
416         char            p_comm[MAXCOMLEN + 1];  /* (b) Process name. */
417         struct pgrp     *p_pgrp;        /* (e?/c?) Pointer to process group. */
418         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
419         struct pargs    *p_args;        /* (c) Process arguments. */
420 /* End area that is copied on creation. */
421 #define p_endcopy       p_xstat
422
423         u_short         p_xstat;        /* (c) Exit status; also stop sig. */
424         struct mdproc   p_md;           /* (c) Any machine-dependent fields. */
425         struct callout  p_itcallout;    /* (h) Interval timer callout. */
426         struct user     *p_uarea;       /* (k) Kernel VA of u-area (CPU) */
427         u_short         p_acflag;       /* (c) Accounting flags. */
428         struct rusage   *p_ru;          /* (a) Exit information. XXX */
429         struct proc     *p_peers;       /* (c) */
430         struct proc     *p_leader;      /* (c) */
431         void            *p_emuldata;    /* (c) Emulator state data. */
432 };
433
434 #define p_rlimit        p_limit->pl_rlimit
435 #define p_sigacts       p_procsig->ps_sigacts
436 #define p_sigignore     p_procsig->ps_sigignore
437 #define p_sigcatch      p_procsig->ps_sigcatch
438 #define p_session       p_pgrp->pg_session
439 #define p_pgid          p_pgrp->pg_id
440
441 #define NOCPU   0xff            /* For p_oncpu when we aren't on a CPU. */
442
443 /* Status values (p_stat). */
444 #define SIDL    1               /* Process being created by fork. */
445 #define SRUN    2               /* Currently runnable. */
446 #define SSLEEP  3               /* Sleeping on an address. */
447 #define SSTOP   4               /* Process debugging or suspension. */
448 #define SZOMB   5               /* Awaiting collection by parent. */
449 #define SWAIT   6               /* Waiting for interrupt. */
450 #define SMTX    7               /* Blocked on a mutex. */
451
452 /* These flags are kept in p_flag. */
453 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
454 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
455 #define P_KTHREAD       0x00004 /* Kernel thread. (*)*/
456 #define P_NOLOAD        0x00008 /* Ignore during load avg calculations. */
457 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
458 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
459 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
460 #define P_TRACED        0x00800 /* Debugged process being traced. */
461 #define P_WAITED        0x01000 /* Debugging process has waited for child. */
462 #define P_WEXIT         0x02000 /* Working on exiting. */
463 #define P_EXEC          0x04000 /* Process called exec. */
464 #define P_KSES          0x08000 /* Process is using KSEs. */
465
466 /* Should be moved to machine-dependent areas. */
467 #define P_BUFEXHAUST    0x100000 /* Dirty buffers flush is in progress. */
468 #define P_COWINPROGRESS 0x400000 /* Snapshot copy-on-write in progress. */
469
470 #define P_JAILED        0x1000000 /* Process is in jail. */
471 #define P_OLDMASK       0x2000000 /* Need to restore mask after suspend. */
472 #define P_ALTSTACK      0x4000000 /* Have alternate signal stack. */
473 #define P_INEXEC        0x8000000 /* Process is in execve(). */
474
475 /* These flags are kept in p_sflag and are protected with sched_lock. */
476 #define PS_INMEM        0x00001 /* Loaded into memory. */
477 #define PS_PROFIL       0x00004 /* Has started profiling. */
478 #define PS_ALRMPEND     0x00020 /* Pending SIGVTALRM needs to be posted. */
479 #define PS_PROFPEND     0x00040 /* Pending SIGPROF needs to be posted. */
480 #define PS_SWAPINREQ    0x00100 /* Swapin request due to wakeup. */
481 #define PS_SWAPPING     0x00200 /* Process is being swapped. */
482
483 /* flags kept in td_flags */
484 #define TDF_ONRUNQ      0x00001 /* This KE is on a run queue */
485 #define TDF_SINTR       0x00008 /* Sleep is interruptible. */
486 #define TDF_TIMEOUT     0x00010 /* Timing out during sleep. */
487 #define TDF_SELECT      0x00040 /* Selecting; wakeup/waiting danger. */
488 #define TDF_CVWAITQ     0x00080 /* Thread is on a cv_waitq (not slpq). */
489 #define TDF_TIMOFAIL    0x01000 /* Timeout from sleep after we were awake. */
490 #define TDF_DEADLKTREAT 0x800000 /* Lock aquisition - deadlock treatment. */
491
492 /* flags kept in ke_flags */
493 #define KEF_ONRUNQ      0x00001 /* This KE is on a run queue */
494 #define KEF_OWEUPC      0x00002 /* Owe process an addupc() call at next ast. */
495 #define KEF_ASTPENDING  0x00400 /* KSE has a pending ast. */
496 #define KEF_NEEDRESCHED 0x00800 /* Process needs to yield. */
497
498
499 #define P_MAGIC         0xbeefface
500
501 #ifdef _KERNEL
502
503 #ifdef MALLOC_DECLARE
504 MALLOC_DECLARE(M_PARGS);
505 MALLOC_DECLARE(M_SESSION);
506 MALLOC_DECLARE(M_SUBPROC);
507 MALLOC_DECLARE(M_ZOMBIE);
508 #endif
509
510 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
511         LIST_FOREACH((p), &allproc, p_list)
512 #define FOREACH_KSEGRP_IN_PROC(p, kg)                                   \
513         TAILQ_FOREACH((kg), &(p)->p_ksegrps, kg_ksegrp)
514 #define FOREACH_THREAD_IN_GROUP(kg, td)                                 \
515         TAILQ_FOREACH((td), &(kg)->kg_threads, td_kglist)
516 #define FOREACH_KSE_IN_GROUP(kg, ke)                                    \
517         TAILQ_FOREACH((ke), &(kg)->kg_kseq, ke_kglist)
518 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
519         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
520
521 static __inline int
522 sigonstack(size_t sp)
523 {
524         register struct thread *td = curthread;
525         struct proc *p = td->td_proc;
526
527         return ((p->p_flag & P_ALTSTACK) ?
528 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
529             ((p->p_sigstk.ss_size == 0) ? (p->p_sigstk.ss_flags & SS_ONSTACK) :
530                 ((sp - (size_t)p->p_sigstk.ss_sp) < p->p_sigstk.ss_size))
531 #else
532             ((sp - (size_t)p->p_sigstk.ss_sp) < p->p_sigstk.ss_size)
533 #endif
534             : 0);
535 }
536
537 /*
538  * Notify the current process (p) that it has a signal pending,
539  * process as soon as possible.
540  */
541 #define signotify(ke) do {                                              \
542         mtx_assert(&sched_lock, MA_OWNED);                              \
543         (ke)->ke_flags |= KEF_ASTPENDING;                               \
544 } while (0)
545
546 /* Handy macro to determine if p1 can mangle p2. */
547 #define PRISON_CHECK(p1, p2) \
548         ((p1)->p_prison == NULL || (p1)->p_prison == (p2)->p_prison)
549
550 /*
551  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
552  * as it is used to represent "no process group".
553  */
554 #define PID_MAX         99999
555 #define NO_PID          100000
556
557 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
558 #define SESSHOLD(s)     ((s)->s_count++)
559 #define SESSRELE(s) {                                                   \
560         if (--(s)->s_count == 0)                                        \
561                 FREE(s, M_SESSION);                                     \
562 }
563
564 #define STOPEVENT(p, e, v) do {                                         \
565         PROC_LOCK(p);                                                   \
566         _STOPEVENT((p), (e), (v));                                      \
567         PROC_UNLOCK(p);                                                 \
568 } while (0)
569 #define _STOPEVENT(p, e, v) do {                                        \
570         PROC_LOCK_ASSERT(p, MA_OWNED);                                  \
571         if ((p)->p_stops & (e)) {                                       \
572                 stopevent((p), (e), (v));                               \
573         }                                                               \
574 } while (0)
575
576 /* Lock and unlock a process. */
577 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
578 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
579 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
580 #define PROC_UNLOCK_NOSWITCH(p)                                         \
581         mtx_unlock_flags(&(p)->p_mtx, MTX_NOSWITCH)
582 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
583 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
584
585 /* Hold process U-area in memory, normally for ptrace/procfs work. */
586 #define PHOLD(p) do {                                                   \
587         PROC_LOCK(p);                                                   \
588         _PHOLD(p);                                                      \
589         PROC_UNLOCK(p);                                                 \
590 } while (0)
591 #define _PHOLD(p) do {                                                  \
592         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
593         if ((p)->p_lock++ == 0)                                         \
594                 faultin((p));                                           \
595 } while (0)
596
597 #define PRELE(p) do {                                                   \
598         PROC_LOCK((p));                                                 \
599         _PRELE((p));                                                    \
600         PROC_UNLOCK((p));                                               \
601 } while (0)
602 #define _PRELE(p) do {                                                  \
603         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
604         (--(p)->p_lock);                                                \
605 } while (0)
606
607 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
608 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
609 extern u_long pidhash;
610
611 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
612 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
613 extern u_long pgrphash;
614
615 extern struct sx allproc_lock;
616 extern struct sx proctree_lock;
617 extern struct proc proc0;               /* Process slot for swapper. */
618 extern struct thread *thread0;          /* Primary thread in proc0 */
619 extern int hogticks;                    /* Limit on kernel cpu hogs. */
620 extern int nprocs, maxproc;             /* Current and max number of procs. */
621 extern int maxprocperuid;               /* Max procs per uid. */
622 extern u_long ps_arg_cache_limit;
623 extern int ps_argsopen;
624 extern int ps_showallprocs;
625 extern int sched_quantum;               /* Scheduling quantum in ticks. */
626
627 LIST_HEAD(proclist, proc);
628 TAILQ_HEAD(procqueue, proc);
629 TAILQ_HEAD(threadqueue, thread);
630 extern struct proclist allproc;         /* List of all processes. */
631 extern struct proclist zombproc;        /* List of zombie processes. */
632 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
633 extern struct proc *updateproc;         /* Process slot for syncer (sic). */
634
635 extern struct vm_zone *proc_zone;
636
637 extern int lastpid;
638
639 /*
640  * XXX macros for scheduler.  Shouldn't be here, but currently needed for
641  * bounding the dubious p_estcpu inheritance in wait1().
642  * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in
643  * the range 100-256 Hz (approximately).
644  */
645 #define ESTCPULIM(e) \
646     min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * (PRIO_MAX - PRIO_MIN) - \
647              RQ_PPQ) + INVERSE_ESTCPU_WEIGHT - 1)
648 #define INVERSE_ESTCPU_WEIGHT   8       /* 1 / (priorities per estcpu level). */
649 #define NICE_WEIGHT     1               /* Priorities per nice level. */
650
651 struct  proc *pfind __P((pid_t));       /* Find process by id. */
652 struct  pgrp *pgfind __P((pid_t));      /* Find process group by id. */
653 struct  proc *zpfind __P((pid_t));      /* Find zombie process by id. */
654
655 void    ast __P((struct trapframe *framep));
656 struct  thread *choosethread __P((void));
657 int     enterpgrp __P((struct proc *p, pid_t pgid, int mksess));
658 void    faultin __P((struct proc *p));
659 void    fixjobc __P((struct proc *p, struct pgrp *pgrp, int entering));
660 int     fork1 __P((struct thread *, int, struct proc **));
661 void    fork_exit __P((void (*)(void *, struct trapframe *), void *,
662             struct trapframe *));
663 void    fork_return __P((struct thread *, struct trapframe *));
664 int     inferior __P((struct proc *p));
665 int     leavepgrp __P((struct proc *p));
666 void    mi_switch __P((void));
667 int     p_candebug __P((struct proc *p1, struct proc *p2));
668 int     p_cansee __P((struct proc *p1, struct proc *p2));
669 int     p_cansched __P((struct proc *p1, struct proc *p2));
670 int     p_cansignal __P((struct proc *p1, struct proc *p2, int signum));
671 int     p_trespass __P((struct proc *p1, struct proc *p2));
672 void    procinit __P((void));
673 void    proc_linkup __P((struct proc *p));
674 void    proc_reparent __P((struct proc *child, struct proc *newparent));
675 int     procrunnable __P((void));
676 void    remrunqueue __P((struct thread *));
677 void    resetpriority __P((struct ksegrp *));
678 int     roundrobin_interval __P((void));
679 void    schedclock __P((struct thread *));
680 int     securelevel_ge __P((struct ucred *cr, int level));
681 int     securelevel_gt __P((struct ucred *cr, int level));
682 void    setrunnable __P((struct thread *));
683 void    setrunqueue __P((struct thread *));
684 void    setsugid __P((struct proc *p));
685 void    sleepinit __P((void));
686 void    stopevent __P((struct proc *, u_int, u_int));
687 void    cpu_idle __P((void));
688 void    cpu_switch __P((void));
689 void    cpu_throw __P((void)) __dead2;
690 void    unsleep __P((struct thread *));
691 void    updatepri __P((struct thread *));
692 void    userret __P((struct thread *, struct trapframe *, u_int));
693 void    maybe_resched __P((struct ksegrp *));
694
695 void    cpu_exit __P((struct thread *));
696 void    exit1 __P((struct thread *, int)) __dead2;
697 void    cpu_fork __P((struct thread *, struct proc *, int));
698 void    cpu_set_fork_handler __P((struct thread *, void (*)(void *), void *));
699 int     trace_req __P((struct proc *));
700 void    cpu_wait __P((struct proc *));
701 int     cpu_coredump __P((struct thread *, struct vnode *, struct ucred *));
702 #endif  /* _KERNEL */
703
704 #endif  /* !_SYS_PROC_H_ */