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.83 2006/08/27 12:54:59 davidxu Exp $
46 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
48 #error "Userland must include sys/user.h instead of sys/proc.h"
52 #include <sys/callout.h> /* For struct callout_handle. */
53 #include <sys/filedesc.h>
54 #include <sys/queue.h>
55 #include <sys/rtprio.h> /* For struct rtprio. */
56 #include <sys/signal.h>
58 #include <sys/time.h> /* For structs itimerval, timeval. */
60 #include <sys/ucred.h>
61 #include <sys/event.h> /* For struct klist */
62 #include <sys/thread.h>
63 #include <sys/varsym.h>
64 #include <sys/upcall.h>
65 #include <sys/resourcevar.h>
67 #include <sys/globaldata.h>
69 #include <sys/systimer.h>
70 #include <sys/usched.h>
71 #include <machine/proc.h> /* Machine-dependent proc substruct. */
74 * One structure allocated per session.
77 int s_count; /* Ref cnt; pgrps in session. */
78 struct proc *s_leader; /* Session leader. */
79 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
80 struct tty *s_ttyp; /* Controlling terminal. */
81 pid_t s_sid; /* Session ID */
82 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
86 * One structure allocated per process group.
89 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
90 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
91 struct session *pg_session; /* Pointer to session. */
92 struct sigiolst pg_sigiolst; /* List of sigio sources. */
93 pid_t pg_id; /* Pgrp id. */
94 int pg_jobc; /* # procs qualifying pgrp for job control */
98 sigset_t ps_sigignore; /* Signals being ignored. */
99 sigset_t ps_sigcatch; /* Signals being caught by user. */
101 struct sigacts *ps_sigacts;
105 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
106 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
109 * pargs, used to hold a copy of the command line, if it had a sane
113 u_int ar_ref; /* Reference count */
114 u_int ar_length; /* Length */
115 u_char ar_args[0]; /* Arguments */
119 * Description of a process.
121 * This structure contains the information needed to manage a thread of
122 * control, known in UN*X as a process; it has references to substructures
123 * containing descriptions of things that the process uses, but may share
124 * with related processes. The process structure and the substructures
125 * are always addressable except for those marked "(PROC ONLY)" below,
126 * which might be addressable only on a processor on which the process
129 * NOTE! The process start time is stored in the thread structure associated
130 * with the process. If the process is a Zombie, then this field will be
131 * inaccessible due to the thread structure being free'd in kern_wait1().
138 TAILQ_ENTRY(lwp) lwp_procq; /* run/sleep queue. */
139 LIST_ENTRY(lwp) lwp_list; /* List of all threads in the proc. */
141 struct proc *lwp_proc; /* Link to our proc. */
143 lwpid_t lwp_tid; /* Our thread id . */
145 struct pstats *lwp_stats; /* Accounting/statistics (PROC ONLY). */
147 int lwp_flag; /* P_* flags. */
148 char lwp_stat; /* S* process status. */
151 #define lwp_startzero lwp_dupfd
152 int lwp_dupfd; /* Sideways return value from fdopen. XXX */
157 sysclock_t lwp_cpticks; /* cpu used in sched clock ticks */
158 sysclock_t lwp_cpbase; /* Measurement base */
159 fixpt_t lwp_pctcpu; /* %cpu for this process */
160 u_int lwp_swtime; /* Time swapped in or out. */
161 u_int lwp_slptime; /* Time since last blocked. */
163 int lwp_traceflag; /* Kernel trace points. */
165 union usched_data lwp_usdata; /* User scheduler specific */
166 #define lwp_endzero lwp_startcopy
168 #define lwp_startcopy lwp_cpumask
169 cpumask_t lwp_cpumask;
170 sigset_t lwp_siglist; /* Signals arrived but not delivered. */
171 sigset_t lwp_oldsigmask; /* saved mask from before sigpause */
172 sigset_t lwp_sigmask; /* Current signal mask. */
173 stack_t lwp_sigstk; /* sp & on stack state variable */
175 struct rtprio lwp_rtprio; /* Realtime priority. */
176 #define lwp_endcopy lwp_md
179 struct user *lwp_addr; /* XXX Really struct user? */
181 struct mdproc lwp_md; /* Any machine-dependent fields. */
183 struct thread *lwp_thread; /* backpointer to proc's thread */
184 struct upcall *lwp_upcall; /* REGISTERED USERLAND POINTER! */
188 LIST_ENTRY(proc) p_list; /* List of all processes. */
191 struct ucred *p_ucred; /* Process owner's identity. */
192 struct filedesc *p_fd; /* Ptr to open files structure. */
193 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */
194 #define p_stats p_lwp.lwp_stats
195 struct plimit *p_limit; /* Process limits. */
197 struct procsig *p_procsig;
198 #define p_sigacts p_procsig->ps_sigacts
199 #define p_sigignore p_procsig->ps_sigignore
200 #define p_sigcatch p_procsig->ps_sigcatch
201 #define p_rlimit p_limit->pl_rlimit
203 int p_flag; /* P_* flags. */
204 char p_stat; /* S* process status. */
207 pid_t p_pid; /* Process identifier. */
208 LIST_ENTRY(proc) p_hash; /* Hash chain. */
209 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
210 struct proc *p_pptr; /* Pointer to parent process. */
211 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
212 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */
213 struct callout p_ithandle; /* for scheduling p_realtimer */
214 struct varsymset p_varsymset;
216 /* The following fields are all zeroed upon creation in fork. */
217 #define p_startzero p_oppid
219 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
221 struct vmspace *p_vmspace; /* Address space. */
223 #define p_cpticks p_lwp.lwp_cpticks
224 #define p_cpbase p_lwp.lwp_cpbase
225 #define p_pctcpu p_lwp.lwp_pctcpu
226 #define p_swtime p_lwp.lwp_swtime
227 #define p_slptime p_lwp.lwp_slptime
229 struct itimerval p_realtimer; /* Alarm timer. */
230 struct itimerval p_timer[3]; /* Virtual-time timers. */
232 int p_traceflag; /* Kernel trace points. */
233 struct ktrace_node *p_tracenode; /* Trace to vnode. */
235 sigset_t p_siglist; /* Signals arrived but not delivered. */
237 struct vnode *p_textvp; /* Vnode of executable. */
239 #define p_usdata p_lwp.lwp_usdata
241 unsigned int p_stops; /* procfs event bitmask */
242 unsigned int p_stype; /* procfs stop event type */
243 char p_step; /* procfs stop *once* flag */
244 unsigned char p_pfsflags; /* procfs flags */
245 char p_pad2[2]; /* padding for alignment */
246 struct sigiolst p_sigiolst; /* list of sigio sources */
247 int p_sigparent; /* signal to parent on exit */
248 #define p_oldsigmask p_lwp.lwp_oldsigmask
249 int p_sig; /* for core dump/debugger XXX */
250 u_long p_code; /* for core dump/debugger XXX */
251 struct klist p_klist; /* knotes attached to this process */
253 struct timeval p_start; /* start time for a process */
255 /* End area that is zeroed on creation. */
256 #define p_endzero p_startcopy
258 /* The following fields are all copied upon creation in fork. */
259 #define p_startcopy p_comm
261 #define p_sigmask p_lwp.lwp_sigmask
262 #define p_sigstk p_lwp.lwp_sigstk
264 char p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
265 char p_lock; /* Process lock (prevent swap) count. */
266 char p_nice; /* Process "nice" value. */
269 struct pgrp *p_pgrp; /* Pointer to process group. */
271 struct sysentvec *p_sysent; /* System call dispatch information. */
273 struct uprof p_prof; /* Profiling arguments. */
274 struct rtprio p_rtprio; /* Realtime priority. */
275 struct pargs *p_args;
276 /* End area that is copied on creation. */
277 #define p_endcopy p_addr
278 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY) XXX lwp */
279 #define p_md p_lwp.lwp_md
281 u_short p_xstat; /* Exit status or last stop signal */
282 u_short p_acflag; /* Accounting flags. */
283 struct rusage *p_ru; /* Exit information. XXX */
285 int p_nthreads; /* Number of threads in this process. */
286 int p_nstopped; /* Number of stopped threads. */
287 int p_lasttid; /* Last tid used. */
288 LIST_HEAD(, lwp) p_lwps; /* List of threads in this process. */
289 void *p_aioinfo; /* ASYNC I/O info */
290 int p_wakeup; /* thread id XXX lwp */
291 struct proc *p_peers; /* XXX lwp */
292 struct proc *p_leader; /* XXX lwp */
293 void *p_emuldata; /* process-specific emulator state */
294 #define p_thread p_lwp.lwp_thread
295 struct usched *p_usched; /* Userland scheduling control */
296 int p_numposixlocks; /* number of POSIX locks */
298 struct lwp p_lwp; /* Embedded lwp XXX */
299 struct spinlock p_spin; /* Spinlock for LWP access to proc */
303 #define p_wchan p_thread->td_wchan
304 #define p_wmesg p_thread->td_wmesg
305 #define p_session p_pgrp->pg_session
306 #define p_pgid p_pgrp->pg_id
310 * Status values. Please note that p_stat doesn't actually take on
311 * synthesized states.
313 #define SIDL 1 /* Process being created by fork. */
314 #define SRUN 2 /* Currently runnable. */
315 #define SSLEEP 3 /* Sleeping on an address. */
316 #define SSTOP 4 /* Synthesized from SSLEEP + P_STOPPED */
317 #define SZOMB 5 /* Synthesized from P_ZOMBIE for eproc only */
318 #define STHREAD 6 /* Synthesized for eproc only */
320 /* These flags are kept in p_flags. */
321 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
322 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
323 #define P_SWAPPEDOUT 0x00004 /* Swapped out of memory */
324 #define P_BREAKTSLEEP 0x00008 /* Event pending, break tsleep on sigcont */
325 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
326 #define P_PROFIL 0x00020 /* Has started profiling. */
327 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
328 #define P_SINTR 0x00080 /* Sleep is interruptible. */
329 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
330 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
331 #define P_STOPPED 0x00400 /* SIGSTOP status */
332 #define P_TRACED 0x00800 /* Debugged process being traced. */
333 #define P_WAITED 0x01000 /* SIGSTOP status was returned by wait3/4 */
334 #define P_WEXIT 0x02000 /* Working on exiting. */
335 #define P_EXEC 0x04000 /* Process called exec. */
337 /* Should probably be changed into a hold count. */
338 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
339 /* was P_PHYSIO 0x10000 was: Doing physical I/O; use p->p_hold */
341 #define P_UPCALLPEND 0x20000 /* an upcall is pending */
343 #define P_SWAPWAIT 0x40000 /* Waiting for a swapin */
344 #define P_ZOMBIE 0x80000 /* Now in a zombied state */
346 /* Marked a kernel thread */
347 #define P_ONRUNQ 0x100000 /* on a user scheduling run queue */
348 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
349 #define P_IDLESWAP 0x400000 /* Swapout was due to idleswap, not load */
350 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
352 #define P_JAILED 0x1000000 /* Process is in jail */
353 #define P_OLDMASK 0x2000000 /* need to restore mask before pause */
354 #define P_ALTSTACK 0x4000000 /* have alternate signal stack */
355 #define P_INEXEC 0x8000000 /* Process is in execve(). */
356 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */
357 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */
358 #define P_XCPU 0x40000000 /* SIGXCPU */
362 #ifdef MALLOC_DECLARE
363 MALLOC_DECLARE(M_SESSION);
364 MALLOC_DECLARE(M_SUBPROC);
365 MALLOC_DECLARE(M_ZOMBIE);
366 MALLOC_DECLARE(M_PARGS);
369 /* flags for suser_xxx() */
370 #define PRISON_ROOT 0x1
371 #define NULL_CRED_OKAY 0x2
373 /* Handy macro to determine if p1 can mangle p2 */
375 #define PRISON_CHECK(cr1, cr2) \
376 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
379 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
380 * as it is used to represent "no process group".
382 #define PID_MAX 99999
383 #define NO_PID 100000
385 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
390 extern void stopevent(struct proc*, unsigned int, unsigned int);
391 #define STOPEVENT(p,e,v) \
393 if ((p)->p_stops & (e)) { \
398 /* hold process U-area in memory, normally for ptrace/procfs work */
399 #define PHOLD(p) (++(p)->p_lock)
400 #define PRELE(p) (--(p)->p_lock)
402 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
403 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
404 extern u_long pidhash;
406 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
407 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
408 extern u_long pgrphash;
412 #define SET_CURPROC(p) (curproc = (p))
416 extern struct proc proc0; /* Process slot for swapper. */
417 extern struct thread thread0; /* Thread slot for swapper. */
418 extern int hogticks; /* Limit on kernel cpu hogs. */
419 extern int nprocs, maxproc; /* Current and max number of procs. */
420 extern int maxprocperuid; /* Max procs per uid. */
421 extern int sched_quantum; /* Scheduling quantum in ticks */
423 LIST_HEAD(proclist, proc);
424 extern struct proclist allproc; /* List of all processes. */
425 extern struct proclist zombproc; /* List of zombie processes. */
426 extern struct proc *initproc; /* Process slot for init */
427 extern struct thread *pagethread, *updatethread;
430 * Scheduler independant variables. The primary scheduler polling frequency,
431 * the maximum ESTCPU value, and the weighting factor for nice values. A
432 * cpu bound program's estcpu will increase to ESTCPUMAX - 1.
434 #define ESTCPUFREQ 50
436 extern u_long ps_arg_cache_limit;
437 extern int ps_argsopen;
438 extern int ps_showallprocs;
440 struct proc *pfind (pid_t); /* Find process by id. */
441 struct pgrp *pgfind (pid_t); /* Find process group by id. */
442 struct proc *zpfind (pid_t); /* Find zombie process by id. */
446 extern struct vm_zone *proc_zone;
448 int enterpgrp (struct proc *p, pid_t pgid, int mksess);
449 void proc_add_allproc(struct proc *p);
450 void proc_move_allproc_zombie(struct proc *);
451 void proc_remove_zombie(struct proc *);
452 void allproc_scan(int (*callback)(struct proc *, void *), void *data);
453 void zombproc_scan(int (*callback)(struct proc *, void *), void *data);
454 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
455 void updatepcpu(struct lwp *, int, int);
456 int inferior (struct proc *p);
457 int leavepgrp (struct proc *p);
458 void sess_hold(struct session *sp);
459 void sess_rele(struct session *sp);
460 void mi_switch (struct proc *p);
461 void procinit (void);
462 void relscurproc(struct proc *curp);
463 int p_trespass (struct ucred *cr1, struct ucred *cr2);
464 void setrunnable (struct proc *);
465 void clrrunnable (struct proc *);
466 void sleep_gdinit (struct globaldata *);
467 int suser (struct thread *td);
468 int suser_proc (struct proc *p);
469 int suser_cred (struct ucred *cred, int flag);
470 void cpu_heavy_switch (struct thread *);
471 void cpu_lwkt_switch (struct thread *);
473 void cpu_proc_exit (void) __dead2;
474 void cpu_thread_exit (void) __dead2;
475 void exit1 (int) __dead2;
476 void cpu_fork (struct proc *, struct proc *, int);
477 void cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
478 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
479 int fork1 (struct lwp *, int, struct proc **);
480 void start_forked_proc (struct lwp *, struct proc *);
481 int trace_req (struct proc *);
482 void cpu_proc_wait (struct proc *);
483 void cpu_thread_wait (struct thread *);
484 int cpu_coredump (struct thread *, struct vnode *, struct ucred *);
485 void setsugid (void);
486 void faultin (struct proc *p);
487 void swapin_request (void);
489 u_int32_t procrunnable (void);
493 #endif /* _KERNEL || _KERNEL_STRUCTURES */
494 #endif /* !_SYS_PROC_H_ */