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
39 * $FreeBSD: src/sys/sys/proc.h,v 1.99.2.9 2003/06/06 20:21:32 tegge Exp $
40 * $DragonFly: src/sys/sys/proc.h,v 1.11 2003/06/22 04:30:43 dillon Exp $
46 #include <sys/callout.h> /* For struct callout_handle. */
47 #include <sys/filedesc.h>
48 #include <sys/queue.h>
49 #include <sys/rtprio.h> /* For struct rtprio. */
50 #include <sys/signal.h>
52 #include <sys/time.h> /* For structs itimerval, timeval. */
54 #include <sys/ucred.h>
55 #include <sys/event.h> /* For struct klist */
56 #include <sys/thread.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 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
72 * One structure allocated per process group.
75 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
76 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
77 struct session *pg_session; /* Pointer to session. */
78 struct sigiolst pg_sigiolst; /* List of sigio sources. */
79 pid_t pg_id; /* Pgrp id. */
80 int pg_jobc; /* # procs qualifying pgrp for job control */
84 sigset_t ps_sigignore; /* Signals being ignored. */
85 sigset_t ps_sigcatch; /* Signals being caught by user. */
87 struct sigacts *ps_sigacts;
91 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
92 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
95 * pargs, used to hold a copy of the command line, if it had a sane
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 "(PROC ONLY)" below,
112 * which might be addressable only on a processor on which the process
119 TAILQ_ENTRY(proc) p_procq; /* run/sleep queue. */
120 LIST_ENTRY(proc) p_list; /* List of all processes. */
123 struct pcred *p_cred; /* Process owner's identity. */
124 struct filedesc *p_fd; /* Ptr to open files structure. */
125 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */
126 struct pstats *p_stats; /* Accounting/statistics (PROC ONLY). */
127 struct plimit *p_limit; /* Process limits. */
129 struct vm_object *p_upages_obj;/* Upages object */
133 struct procsig *p_procsig;
134 #define p_sigacts p_procsig->ps_sigacts
135 #define p_sigignore p_procsig->ps_sigignore
136 #define p_sigcatch p_procsig->ps_sigcatch
138 #define p_ucred p_cred->pc_ucred
139 #define p_rlimit p_limit->pl_rlimit
141 int p_flag; /* P_* flags. */
142 char p_stat; /* S* process status. */
145 pid_t p_pid; /* Process identifier. */
146 LIST_ENTRY(proc) p_hash; /* Hash chain. */
147 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
148 struct proc *p_pptr; /* Pointer to parent process. */
149 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
150 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */
152 struct callout_handle p_ithandle; /*
153 * Callout handle for scheduling
156 /* The following fields are all zeroed upon creation in fork. */
157 #define p_startzero p_oppid
159 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
160 int p_dupfd; /* Sideways return value from fdopen. XXX */
162 struct vmspace *p_vmspace; /* Address space. */
165 u_int p_estcpu; /* Time averaged value of p_cpticks. */
166 int p_cpticks; /* Ticks of cpu time. */
167 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
168 void *p_wchan; /* Sleep address. */
169 const char *p_wmesg; /* Reason for sleep. */
170 u_int p_swtime; /* Time swapped in or out. */
171 u_int p_slptime; /* Time since last blocked. */
173 struct itimerval p_realtimer; /* Alarm timer. */
174 u_int64_t p_runtime; /* Real time in microsec. */
175 u_int64_t p_uu; /* Previous user time in microsec. */
176 u_int64_t p_su; /* Previous system time in microsec. */
177 u_int64_t p_iu; /* Previous interrupt time in usec. */
178 u_int64_t p_uticks; /* Statclock hits in user mode. */
179 u_int64_t p_sticks; /* Statclock hits in system mode. */
180 u_int64_t p_iticks; /* Statclock hits processing intr. */
182 int p_traceflag; /* Kernel trace points. */
183 struct vnode *p_tracep; /* Trace to vnode. */
185 sigset_t p_siglist; /* Signals arrived but not delivered. */
187 struct vnode *p_textvp; /* Vnode of executable. */
189 char p_lock; /* Process lock (prevent swap) count. */
190 u_char p_oncpu; /* Which cpu we are on */
191 u_char p_lastcpu; /* Last cpu we were on */
192 char p_rqindex; /* Run queue index */
194 short p_locks; /* DEBUG: lockmgr count of held locks */
195 short p_simple_locks; /* DEBUG: count of held simple locks */
196 unsigned int p_stops; /* procfs event bitmask */
197 unsigned int p_stype; /* procfs stop event type */
198 char p_step; /* procfs stop *once* flag */
199 unsigned char p_pfsflags; /* procfs flags */
200 char p_pad3[2]; /* padding for alignment */
201 register_t p_retval[2]; /* syscall aux returns */
202 struct sigiolst p_sigiolst; /* list of sigio sources */
203 int p_sigparent; /* signal to parent on exit */
204 sigset_t p_oldsigmask; /* saved mask from before sigpause */
205 int p_sig; /* for core dump/debugger XXX */
206 u_long p_code; /* for core dump/debugger XXX */
207 struct klist p_klist; /* knotes attached to this process */
209 /* End area that is zeroed on creation. */
210 #define p_endzero p_startcopy
212 /* The following fields are all copied upon creation in fork. */
213 #define p_startcopy p_sigmask
215 sigset_t p_sigmask; /* Current signal mask. */
216 stack_t p_sigstk; /* sp & on stack state variable */
217 u_char p_priority; /* Process priority. */
218 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */
219 char p_nice; /* Process "nice" value. */
220 char p_comm[MAXCOMLEN+1];
222 struct pgrp *p_pgrp; /* Pointer to process group. */
224 struct sysentvec *p_sysent; /* System call dispatch information. */
226 struct rtprio p_rtprio; /* Realtime priority. */
227 struct prison *p_prison;
228 struct pargs *p_args;
229 /* End area that is copied on creation. */
230 #define p_endcopy p_addr
231 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
232 struct mdproc p_md; /* Any machine-dependent fields. */
234 u_short p_xstat; /* Exit status for wait; also stop signal. */
235 u_short p_acflag; /* Accounting flags. */
236 struct rusage *p_ru; /* Exit information. XXX */
238 int p_nthreads; /* number of threads (only in leader) */
239 void *p_aioinfo; /* ASYNC I/O info */
240 int p_wakeup; /* thread id */
241 struct proc *p_peers;
242 struct proc *p_leader;
243 void *p_emuldata; /* process-specific emulator state data */
244 struct thread *p_thread; /* temporarily embed thread struct in proc */
247 #define p_session p_pgrp->pg_session
248 #define p_pgid p_pgrp->pg_id
251 #define SIDL 1 /* Process being created by fork. */
252 #define SRUN 2 /* Currently runnable. */
253 #define SSLEEP 3 /* Sleeping on an address. */
254 #define SSTOP 4 /* Process debugging or suspension. */
255 #define SZOMB 5 /* Awaiting collection by parent. */
257 /* These flags are kept in p_flags. */
258 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
259 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
260 #define P_INMEM 0x00004 /* Loaded into memory. */
261 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
262 #define P_PROFIL 0x00020 /* Has started profiling. */
263 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
264 #define P_SINTR 0x00080 /* Sleep is interruptible. */
265 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
266 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
267 #define P_TIMEOUT 0x00400 /* Timing out during sleep. */
268 #define P_TRACED 0x00800 /* Debugged process being traced. */
269 #define P_WAITED 0x01000 /* Debugging process has waited for child. */
270 #define P_WEXIT 0x02000 /* Working on exiting. */
271 #define P_EXEC 0x04000 /* Process called exec. */
273 /* Should probably be changed into a hold count. */
274 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
275 /* was P_PHYSIO 0x10000 was: Doing physical I/O; use p->p_hold */
277 /* Should be moved to machine-dependent areas. */
278 #define P_OWEUPC 0x20000 /* Owe process an addupc() call at next ast. */
280 #define P_SWAPPING 0x40000 /* Process is being swapped. */
281 #define P_SWAPINREQ 0x80000 /* Swapin request due to wakeup */
283 /* Marked a kernel thread */
284 #define P_UNUSED100000 0x100000
285 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
286 #define P_XSLEEP 0x400000 /* process sitting on xwait_t structure */
288 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
290 #define P_JAILED 0x1000000 /* Process is in jail */
291 #define P_OLDMASK 0x2000000 /* need to restore mask before pause */
292 #define P_ALTSTACK 0x4000000 /* have alternate signal stack */
293 #define P_INEXEC 0x8000000 /* Process is in execve(). */
294 #define P_EXITINTERLOCK 0x10000000 /* Reaping process exit interlock */
299 * Shareable process credentials (always resident). This includes a reference
300 * to the current user credentials as well as real and saved ids that may be
301 * used to change ids.
304 struct ucred *pc_ucred; /* Current credentials. */
305 uid_t p_ruid; /* Real user id. */
306 uid_t p_svuid; /* Saved effective user id. */
307 gid_t p_rgid; /* Real group id. */
308 gid_t p_svgid; /* Saved effective group id. */
309 int p_refcnt; /* Number of references. */
310 struct uidinfo *p_uidinfo; /* Per uid resource consumption */
316 #ifdef MALLOC_DECLARE
317 MALLOC_DECLARE(M_SESSION);
318 MALLOC_DECLARE(M_SUBPROC);
319 MALLOC_DECLARE(M_ZOMBIE);
320 MALLOC_DECLARE(M_PARGS);
323 /* flags for suser_xxx() */
324 #define PRISON_ROOT 1
326 /* Handy macro to determine of p1 can mangle p2 */
328 #define PRISON_CHECK(p1, p2) \
329 ((!(p1)->p_prison) || (p1)->p_prison == (p2)->p_prison)
332 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
333 * as it is used to represent "no process group".
335 #define PID_MAX 99999
336 #define NO_PID 100000
338 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
339 #define SESSHOLD(s) ((s)->s_count++)
340 #define SESSRELE(s) { \
341 if (--(s)->s_count == 0) \
342 FREE(s, M_SESSION); \
346 * STOPEVENT is MP SAFE.
348 extern void stopevent(struct proc*, unsigned int, unsigned int);
349 #define STOPEVENT(p,e,v) \
351 if ((p)->p_stops & (e)) { \
358 /* hold process U-area in memory, normally for ptrace/procfs work */
360 if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
363 #define PRELE(p) (--(p)->p_lock)
365 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
366 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
367 extern u_long pidhash;
369 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
370 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
371 extern u_long pgrphash;
375 #define SET_CURPROC(p) (curproc = (p))
379 extern struct proc proc0; /* Process slot for swapper. */
380 extern struct thread thread0; /* Thread slot for swapper. */
381 extern int hogticks; /* Limit on kernel cpu hogs. */
382 extern int nprocs, maxproc; /* Current and max number of procs. */
383 extern int maxprocperuid; /* Max procs per uid. */
384 extern int sched_quantum; /* Scheduling quantum in ticks */
386 LIST_HEAD(proclist, proc);
387 extern struct proclist allproc; /* List of all processes. */
388 extern struct proclist zombproc; /* List of zombie processes. */
389 extern struct proc *initproc, *pageproc, *updateproc; /* Process slots for init, pager. */
391 #define NQS 32 /* 32 run queues. */
392 TAILQ_HEAD(rq, proc);
393 extern struct rq queues[];
394 extern struct rq rtqueues[];
395 extern struct rq idqueues[];
396 extern int whichqs; /* Bit mask summary of non-empty Q's. */
397 extern int whichrtqs; /* Bit mask summary of non-empty Q's. */
398 extern int whichidqs; /* Bit mask summary of non-empty Q's. */
401 * XXX macros for scheduler. Shouldn't be here, but currently needed for
402 * bounding the dubious p_estcpu inheritance in wait1().
403 * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in
404 * the range 100-256 Hz (approximately).
406 #define ESTCPULIM(e) \
407 min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * PRIO_MAX - PPQ) + \
408 INVERSE_ESTCPU_WEIGHT - 1)
409 #define INVERSE_ESTCPU_WEIGHT 8 /* 1 / (priorities per estcpu level) */
410 #define NICE_WEIGHT 2 /* priorities per nice level */
411 #define PPQ (128 / NQS) /* priorities per queue */
413 extern u_long ps_arg_cache_limit;
414 extern int ps_argsopen;
416 struct proc *pfind __P((pid_t)); /* Find process by id. */
417 struct pgrp *pgfind __P((pid_t)); /* Find process group by id. */
418 struct proc *zpfind __P((pid_t)); /* Find zombie process by id. */
421 extern struct vm_zone *proc_zone;
423 int enterpgrp __P((struct proc *p, pid_t pgid, int mksess));
424 void fixjobc __P((struct proc *p, struct pgrp *pgrp, int entering));
425 int inferior __P((struct proc *p));
426 int leavepgrp __P((struct proc *p));
427 void mi_switch __P((void));
428 void procinit __P((void));
429 int p_trespass __P((struct proc *p1, struct proc *p2));
430 void resetpriority __P((struct proc *));
431 int roundrobin_interval __P((void));
432 void schedclock __P((struct proc *));
433 void setrunnable __P((struct proc *));
434 void setrunqueue __P((struct proc *));
435 void sleepinit __P((void));
436 int suser __P((struct proc *));
437 int suser_xxx __P((struct ucred *cred, struct proc *proc, int flag));
438 void remrunqueue __P((struct proc *));
439 void cpu_heavy_switch __P((struct thread *));
440 void cpu_lwkt_switch __P((struct thread *));
441 void unsleep __P((struct proc *));
443 void cpu_exit __P((struct proc *)) __dead2;
444 void exit1 __P((struct proc *, int)) __dead2;
445 void cpu_fork __P((struct proc *, struct proc *, int));
446 void cpu_set_fork_handler __P((struct proc *, void (*)(void *), void *));
447 int fork1 __P((struct proc *, int, struct proc **));
448 void start_forked_proc __P((struct proc *, struct proc *));
449 int trace_req __P((struct proc *));
450 void cpu_wait __P((struct proc *));
451 int cpu_coredump __P((struct proc *, struct vnode *, struct ucred *));
452 void setsugid __P((struct proc *p));
453 void faultin __P((struct proc *p));
455 struct proc * chooseproc __P((void));
456 u_int32_t procrunnable __P((void));
460 #endif /* !_SYS_PROC_H_ */