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.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
38 * @(#)proc.h 8.15 (Berkeley) 5/19/95
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 */
52 #include <sys/signal.h>
54 #include <sys/time.h> /* For structs itimerval, timeval. */
56 #include <sys/ucred.h>
57 #include <machine/proc.h> /* Machine-dependent proc substruct. */
60 * One structure allocated per 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))];
73 * One structure allocated per process group.
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 */
85 sigset_t ps_sigignore; /* Signals being ignored. */
86 sigset_t ps_sigcatch; /* Signals being caught by user. */
88 struct sigacts *ps_sigacts; /* Signal actions, state. */
92 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
93 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
96 * pargs, used to hold a copy of the command line, if it had a sane length.
99 u_int ar_ref; /* Reference count. */
100 u_int ar_length; /* Length. */
101 u_char ar_args[0]; /* Arguments. */
105 * Description of a process.
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
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
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 - either by curproc or a lock which prevents the lock from
132 * going away, such as (d,e)
133 * l - the attaching proc or attaching proc parent
135 * n - not locked, lazy
137 * If the locking key specifies two identifiers (for example, p_pptr) then
138 * either lock is sufficient for read access, but both locks must be held
146 TAILQ_ENTRY(proc) p_procq; /* (j) Run/mutex queue. */
147 TAILQ_ENTRY(proc) p_slpq; /* (j) Sleep queue. */
148 LIST_ENTRY(proc) p_list; /* (d) List of all processes. */
151 struct ucred *p_ucred; /* (c + k) Process owner's identity. */
152 struct filedesc *p_fd; /* (b) Ptr to open files structure. */
153 struct pstats *p_stats; /* (b) Accounting/statistics (CPU). */
154 struct plimit *p_limit; /* (m) Process limits. */
155 struct vm_object *p_upages_obj;/* (a) Upages object. */
156 struct procsig *p_procsig; /* (c) Signal actions, state (CPU). */
157 #define p_sigacts p_procsig->ps_sigacts
158 #define p_sigignore p_procsig->ps_sigignore
159 #define p_sigcatch p_procsig->ps_sigcatch
161 #define p_rlimit p_limit->pl_rlimit
163 int p_flag; /* (c) P_* flags. */
164 int p_sflag; /* (j) PS_* flags. */
165 int p_stat; /* (j) S* process status. */
167 pid_t p_pid; /* (b) Process identifier. */
168 LIST_ENTRY(proc) p_hash; /* (d) Hash chain. */
169 LIST_ENTRY(proc) p_pglist; /* (c) List of processes in pgrp. */
170 struct proc *p_pptr; /* (c + e) Pointer to parent process. */
171 LIST_ENTRY(proc) p_sibling; /* (e) List of sibling processes. */
172 LIST_HEAD(, proc) p_children; /* (e) Pointer to list of children. */
174 /* The following fields are all zeroed upon creation in fork. */
175 #define p_startzero p_oppid
177 pid_t p_oppid; /* (c + e) Save parent pid during ptrace. XXX */
178 int p_dupfd; /* (c) Sideways ret value from fdopen. XXX */
179 struct vmspace *p_vmspace; /* (b) Address space. */
182 u_int p_estcpu; /* (j) Time averaged value of p_cpticks. */
183 int p_cpticks; /* (j) Ticks of cpu time. */
184 fixpt_t p_pctcpu; /* (j) %cpu during p_swtime. */
185 struct callout p_slpcallout; /* (h) Callout for sleep. */
186 void *p_wchan; /* (j) Sleep address. */
187 const char *p_wmesg; /* (j) Reason for sleep. */
188 u_int p_swtime; /* (j) Time swapped in or out. */
189 u_int p_slptime; /* (j) Time since last blocked. */
191 struct callout p_itcallout; /* (h) Interval timer callout. */
192 struct itimerval p_realtimer; /* (h?/k?) Alarm timer. */
193 u_int64_t p_runtime; /* (j) Real time in microsec. */
194 u_int64_t p_uu; /* (j) Previous user time in microsec. */
195 u_int64_t p_su; /* (j) Previous system time in microsec. */
196 u_int64_t p_iu; /* (j) Previous interrupt time in microsec. */
197 u_int64_t p_uticks; /* (j) Statclock hits in user mode. */
198 u_int64_t p_sticks; /* (j) Statclock hits in system mode. */
199 u_int64_t p_iticks; /* (j) Statclock hits processing intr. */
201 int p_traceflag; /* (j?) Kernel trace points. */
202 struct vnode *p_tracep; /* (j?) Trace to vnode. */
204 sigset_t p_siglist; /* (c) Signals arrived but not delivered. */
206 struct vnode *p_textvp; /* (b) Vnode of executable. */
208 struct mtx p_mtx; /* (k) Lock for this struct. */
209 char p_lock; /* (c) Process lock (prevent swap) count. */
210 u_char p_oncpu; /* (j) Which cpu we are on. */
211 u_char p_lastcpu; /* (j) Last cpu we were on. */
212 char p_rqindex; /* (j) Run queue index. */
214 short p_locks; /* (*) DEBUG: lockmgr count of held locks */
215 u_int p_stops; /* (c) Procfs event bitmask. */
216 u_int p_stype; /* (c) Procfs stop event type. */
217 char p_step; /* (c) Procfs stop *once* flag. */
218 u_char p_pfsflags; /* (c) Procfs flags. */
219 char p_pad3[2]; /* Alignment. */
220 register_t p_retval[2]; /* (k) Syscall aux returns. */
221 struct sigiolst p_sigiolst; /* (c) List of sigio sources. */
222 int p_sigparent; /* (c) Signal to parent on exit. */
223 sigset_t p_oldsigmask; /* (c) Saved mask from before sigpause. */
224 int p_sig; /* (n) For core dump/debugger XXX. */
225 u_long p_code; /* (n) For core dump/debugger XXX. */
226 struct klist p_klist; /* (c) Knotes attached to this process. */
227 struct lock_list_entry *p_sleeplocks; /* (k) Held sleep locks. */
228 struct mtx *p_blocked; /* (j) Mutex process is blocked on. */
229 const char *p_mtxname; /* (j) Name of mutex blocked on. */
230 LIST_HEAD(, mtx) p_contested; /* (j) Contested locks. */
232 struct nlminfo *p_nlminfo; /* (?) only used by/for lockd */
233 void *p_aioinfo; /* (c) ASYNC I/O info. */
234 struct ithd *p_ithd; /* (b) For interrupt threads only. */
235 int p_intr_nesting_level; /* (k) Interrupt recursion. */
236 int p_giant_optional; /* (i) Giant Lock Sanity */
238 /* End area that is zeroed on creation. */
239 #define p_endzero p_startcopy
241 /* The following fields are all copied upon creation in fork. */
242 #define p_startcopy p_sigmask
244 sigset_t p_sigmask; /* (c) Current signal mask. */
245 stack_t p_sigstk; /* (c) Stack pointer and on-stack flag. */
247 int p_magic; /* (b) Magic number. */
248 struct priority p_pri; /* (j) Process priority. */
249 char p_nice; /* (j?/k?) Process "nice" value. */
250 char p_comm[MAXCOMLEN + 1]; /* (b) Process name. */
252 struct pgrp *p_pgrp; /* (e?/c?) Pointer to process group. */
253 struct sysentvec *p_sysent; /* (b) System call dispatch information. */
254 struct pargs *p_args; /* (c + k) Process arguments. */
256 /* End area that is copied on creation. */
257 #define p_endcopy p_addr
259 struct user *p_addr; /* (k) Kernel virtual addr of u-area (CPU). */
260 struct mdproc p_md; /* (k) Any machine-dependent fields. */
262 u_short p_xstat; /* (c) Exit status for wait; also stop sig. */
263 u_short p_acflag; /* (c) Accounting flags. */
264 struct rusage *p_ru; /* (a) Exit information. XXX */
266 struct proc *p_peers; /* (c) */
267 struct proc *p_leader; /* (c) */
268 void *p_emuldata; /* (c) Emulator state data. */
269 struct trapframe *p_frame; /* (k) */
272 #define p_session p_pgrp->pg_session
273 #define p_pgid p_pgrp->pg_id
275 #define NOCPU 0xff /* For p_oncpu when we aren't on a CPU. */
277 /* Status values (p_stat). */
278 #define SIDL 1 /* Process being created by fork. */
279 #define SRUN 2 /* Currently runnable. */
280 #define SSLEEP 3 /* Sleeping on an address. */
281 #define SSTOP 4 /* Process debugging or suspension. */
282 #define SZOMB 5 /* Awaiting collection by parent. */
283 #define SWAIT 6 /* Waiting for interrupt. */
284 #define SMTX 7 /* Blocked on a mutex. */
286 /* These flags are kept in p_flag. */
287 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
288 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
289 #define P_KTHREAD 0x00004 /* Kernel thread. */
290 #define P_NOLOAD 0x00008 /* Ignore during load avg calculations. */
291 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
292 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
293 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
294 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
295 #define P_TRACED 0x00800 /* Debugged process being traced. */
296 #define P_WAITED 0x01000 /* Debugging process has waited for child. */
297 #define P_WEXIT 0x02000 /* Working on exiting. */
298 #define P_EXEC 0x04000 /* Process called exec. */
300 /* Should be moved to machine-dependent areas. */
302 #define P_BUFEXHAUST 0x100000 /* Dirty buffers flush is in progress. */
303 #define P_COWINPROGRESS 0x400000 /* Snapshot copy-on-write in progress. */
305 #define P_DEADLKTREAT 0x800000 /* Lock aquisition - deadlock treatment. */
307 #define P_JAILED 0x1000000 /* Process is in jail. */
308 #define P_OLDMASK 0x2000000 /* Need to restore mask after suspend. */
309 #define P_ALTSTACK 0x4000000 /* Have alternate signal stack. */
311 /* These flags are kept in p_sflag and are protected with sched_lock. */
312 #define PS_INMEM 0x00001 /* Loaded into memory. */
313 #define PS_OWEUPC 0x00002 /* Owe process an addupc() call at next ast. */
314 #define PS_PROFIL 0x00004 /* Has started profiling. */
315 #define PS_SINTR 0x00008 /* Sleep is interruptible. */
316 #define PS_TIMEOUT 0x00010 /* Timing out during sleep. */
317 #define PS_ALRMPEND 0x00020 /* Pending SIGVTALRM needs to be posted. */
318 #define PS_PROFPEND 0x00040 /* Pending SIGPROF needs to be posted. */
319 #define PS_CVWAITQ 0x00080 /* Proces is on a cv_waitq (not slpq). */
320 #define PS_SWAPINREQ 0x00100 /* Swapin request due to wakeup. */
321 #define PS_SWAPPING 0x00200 /* Process is being swapped. */
322 #define PS_ASTPENDING 0x00400 /* Process has a pending ast. */
323 #define PS_NEEDRESCHED 0x00800 /* Process needs to yield. */
325 #define P_MAGIC 0xbeefface
328 #define P_CAN_SCHED 3
329 #define P_CAN_DEBUG 4
333 #ifdef MALLOC_DECLARE
334 MALLOC_DECLARE(M_PARGS);
335 MALLOC_DECLARE(M_SESSION);
336 MALLOC_DECLARE(M_SUBPROC);
337 MALLOC_DECLARE(M_ZOMBIE);
341 sigonstack(size_t sp)
343 register struct proc *p = curproc;
345 return ((p->p_flag & P_ALTSTACK) ?
346 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
347 ((p->p_sigstk.ss_size == 0) ? (p->p_sigstk.ss_flags & SS_ONSTACK) :
348 ((sp - (size_t)p->p_sigstk.ss_sp) < p->p_sigstk.ss_size))
350 ((sp - (size_t)p->p_sigstk.ss_sp) < p->p_sigstk.ss_size)
356 * Preempt the current process if in interrupt from user mode,
357 * or after the current trap/syscall if in system mode.
359 #define need_resched(p) do { \
360 mtx_assert(&sched_lock, MA_OWNED); \
361 (p)->p_sflag |= PS_NEEDRESCHED; \
364 #define resched_wanted(p) ((p)->p_sflag & PS_NEEDRESCHED)
366 #define clear_resched(p) do { \
367 mtx_assert(&sched_lock, MA_OWNED); \
368 (p)->p_sflag &= ~PS_NEEDRESCHED; \
372 * Schedule an Asynchronous System Trap (AST) on return to user mode.
374 #define aston(p) do { \
375 mtx_assert(&sched_lock, MA_OWNED); \
376 (p)->p_sflag |= PS_ASTPENDING; \
379 #define astpending(p) ((p)->p_sflag & PS_ASTPENDING)
381 #define astoff(p) do { \
382 mtx_assert(&sched_lock, MA_OWNED); \
383 (p)->p_sflag &= ~PS_ASTPENDING; \
387 * Notify the current process (p) that it has a signal pending,
388 * process as soon as possible.
390 #define signotify(p) aston(p)
392 /* Handy macro to determine if p1 can mangle p2. */
393 #define PRISON_CHECK(p1, p2) \
394 ((p1)->p_prison == NULL || (p1)->p_prison == (p2)->p_prison)
397 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
398 * as it is used to represent "no process group".
400 #define PID_MAX 99999
401 #define NO_PID 100000
403 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
404 #define SESSHOLD(s) ((s)->s_count++)
405 #define SESSRELE(s) { \
406 if (--(s)->s_count == 0) \
407 FREE(s, M_SESSION); \
410 #define STOPEVENT(p, e, v) do { \
412 _STOPEVENT((p), (e), (v)); \
415 #define _STOPEVENT(p, e, v) do { \
416 PROC_LOCK_ASSERT(p, MA_OWNED); \
417 if ((p)->p_stops & (e)) { \
418 stopevent((p), (e), (v)); \
422 /* Lock and unlock a process. */
423 #define PROC_LOCK(p) mtx_lock(&(p)->p_mtx)
424 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
425 #define PROC_UNLOCK(p) mtx_unlock(&(p)->p_mtx)
426 #define PROC_UNLOCK_NOSWITCH(p) \
427 mtx_unlock_flags(&(p)->p_mtx, MTX_NOSWITCH)
428 #define PROC_LOCKED(p) mtx_owned(&(p)->p_mtx)
429 #define PROC_LOCK_ASSERT(p, type) mtx_assert(&(p)->p_mtx, (type))
431 /* Hold process U-area in memory, normally for ptrace/procfs work. */
432 #define PHOLD(p) do { \
437 #define _PHOLD(p) do { \
438 PROC_LOCK_ASSERT((p), MA_OWNED); \
439 if ((p)->p_lock++ == 0) \
443 #define PRELE(p) do { \
448 #define _PRELE(p) do { \
449 PROC_LOCK_ASSERT((p), MA_OWNED); \
453 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
454 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
455 extern u_long pidhash;
457 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
458 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
459 extern u_long pgrphash;
461 extern struct sx allproc_lock;
462 extern struct sx proctree_lock;
463 extern struct proc proc0; /* Process slot for swapper. */
464 extern int hogticks; /* Limit on kernel cpu hogs. */
465 extern int nprocs, maxproc; /* Current and max number of procs. */
466 extern int maxprocperuid; /* Max procs per uid. */
467 extern u_long ps_arg_cache_limit;
468 extern int ps_argsopen;
469 extern int ps_showallprocs;
470 extern int sched_quantum; /* Scheduling quantum in ticks. */
472 LIST_HEAD(proclist, proc);
473 TAILQ_HEAD(procqueue, proc);
474 extern struct proclist allproc; /* List of all processes. */
475 extern struct proclist zombproc; /* List of zombie processes. */
476 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
477 extern struct proc *updateproc; /* Process slot for syncer (sic). */
479 extern struct vm_zone *proc_zone;
484 * XXX macros for scheduler. Shouldn't be here, but currently needed for
485 * bounding the dubious p_estcpu inheritance in wait1().
486 * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in
487 * the range 100-256 Hz (approximately).
489 #define ESTCPULIM(e) \
490 min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * (PRIO_MAX - PRIO_MIN) - \
491 RQ_PPQ) + INVERSE_ESTCPU_WEIGHT - 1)
492 #define INVERSE_ESTCPU_WEIGHT 8 /* 1 / (priorities per estcpu level). */
493 #define NICE_WEIGHT 1 /* Priorities per nice level. */
495 struct proc *pfind __P((pid_t)); /* Find process by id. */
496 struct pgrp *pgfind __P((pid_t)); /* Find process group by id. */
497 struct proc *zpfind __P((pid_t)); /* Find zombie process by id. */
499 void ast __P((struct trapframe *framep));
500 struct proc *chooseproc __P((void));
501 int enterpgrp __P((struct proc *p, pid_t pgid, int mksess));
502 void faultin __P((struct proc *p));
503 void fixjobc __P((struct proc *p, struct pgrp *pgrp, int entering));
504 int fork1 __P((struct proc *, int, struct proc **));
505 void fork_exit __P((void (*)(void *, struct trapframe *), void *,
506 struct trapframe *));
507 void fork_return __P((struct proc *, struct trapframe *));
508 int inferior __P((struct proc *p));
509 int leavepgrp __P((struct proc *p));
510 void mi_switch __P((void));
511 int p_candebug __P((struct proc *p1, struct proc *p2));
512 int p_cansee __P((struct proc *p1, struct proc *p2));
513 int p_cansched __P((struct proc *p1, struct proc *p2));
514 int p_cansignal __P((struct proc *p1, struct proc *p2, int signum));
515 int p_trespass __P((struct proc *p1, struct proc *p2));
516 void procinit __P((void));
517 void proc_reparent __P((struct proc *child, struct proc *newparent));
518 int procrunnable __P((void));
519 void remrunqueue __P((struct proc *));
520 void resetpriority __P((struct proc *));
521 int roundrobin_interval __P((void));
522 void schedclock __P((struct proc *));
523 void setrunnable __P((struct proc *));
524 void setrunqueue __P((struct proc *));
525 void setsugid __P((struct proc *p));
526 void sleepinit __P((void));
527 void stopevent __P((struct proc *, u_int, u_int));
528 void cpu_idle __P((void));
529 void cpu_switch __P((void));
530 void cpu_throw __P((void)) __dead2;
531 void unsleep __P((struct proc *));
532 void updatepri __P((struct proc *));
533 void userret __P((struct proc *, struct trapframe *, u_quad_t));
534 void maybe_resched __P((struct proc *));
536 void cpu_exit __P((struct proc *)) __dead2;
537 void exit1 __P((struct proc *, int)) __dead2;
538 void cpu_fork __P((struct proc *, struct proc *, int));
539 void cpu_set_fork_handler __P((struct proc *, void (*)(void *), void *));
540 int trace_req __P((struct proc *));
541 void cpu_wait __P((struct proc *));
542 int cpu_coredump __P((struct proc *, struct vnode *, struct ucred *));
545 #endif /* !_SYS_PROC_H_ */