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.92 2007/02/03 17:05:59 corecode 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>
59 #include <sys/time.h> /* For structs itimerval, timeval. */
61 #include <sys/ucred.h>
62 #include <sys/event.h> /* For struct klist */
63 #include <sys/thread.h>
64 #include <sys/varsym.h>
65 #include <sys/upcall.h>
66 #include <sys/resourcevar.h>
68 #include <sys/globaldata.h>
70 #include <sys/systimer.h>
71 #include <sys/usched.h>
72 #include <machine/proc.h> /* Machine-dependent proc substruct. */
75 * One structure allocated per session.
78 int s_count; /* Ref cnt; pgrps in session. */
79 struct proc *s_leader; /* Session leader. */
80 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
81 struct tty *s_ttyp; /* Controlling terminal. */
82 pid_t s_sid; /* Session ID */
83 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
87 * One structure allocated per process group.
90 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
91 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
92 struct session *pg_session; /* Pointer to session. */
93 struct sigiolst pg_sigiolst; /* List of sigio sources. */
94 pid_t pg_id; /* Pgrp id. */
95 int pg_jobc; /* # procs qualifying pgrp for job control */
96 struct lock pg_lock; /* Lock during fork */
100 sigset_t ps_sigignore; /* Signals being ignored. */
101 sigset_t ps_sigcatch; /* Signals being caught by user. */
103 struct sigacts *ps_sigacts;
107 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
108 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
111 * pargs, used to hold a copy of the command line, if it had a sane
115 u_int ar_ref; /* Reference count */
116 u_int ar_length; /* Length */
117 u_char ar_args[0]; /* Arguments */
121 * Description of a process.
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 "(PROC ONLY)" below,
128 * which might be addressable only on a processor on which the process
131 * NOTE! The process start time is stored in the thread structure associated
132 * with the process. If the process is a Zombie, then this field will be
133 * inaccessible due to the thread structure being free'd in kern_wait1().
141 TAILQ_ENTRY(lwp) lwp_procq; /* run/sleep queue. */
142 LIST_ENTRY(lwp) lwp_list; /* List of all threads in the proc. */
144 struct proc *lwp_proc; /* Link to our proc. */
146 lwpid_t lwp_tid; /* Our thread id . */
148 int lwp_flag; /* P_* flags. */
150 char lwp_stat; /* S* process status. */
153 #define lwp_startzero lwp_dupfd
154 int lwp_dupfd; /* Sideways return value from fdopen. XXX */
159 sysclock_t lwp_cpticks; /* cpu used in sched clock ticks */
160 sysclock_t lwp_cpbase; /* Measurement base */
161 fixpt_t lwp_pctcpu; /* %cpu for this process */
162 u_int lwp_slptime; /* Time since last blocked. */
164 int lwp_traceflag; /* Kernel trace points. */
166 struct rusage lwp_ru; /* stats for this lwp */
168 union usched_data lwp_usdata; /* User scheduler specific */
169 #define lwp_endzero lwp_startcopy
171 #define lwp_startcopy lwp_cpumask
172 cpumask_t lwp_cpumask;
173 sigset_t lwp_siglist; /* Signals arrived but not delivered. */
174 sigset_t lwp_oldsigmask; /* saved mask from before sigpause */
175 sigset_t lwp_sigmask; /* Current signal mask. */
176 stack_t lwp_sigstk; /* sp & on stack state variable */
178 struct rtprio lwp_rtprio; /* Realtime priority. */
179 #define lwp_endcopy lwp_md
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 struct plimit *p_limit; /* Process limits. */
195 struct pstats *p_stats;
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; /* Current address space. */
223 unsigned int p_swtime; /* Time swapped in or out */
225 struct itimerval p_realtimer; /* Alarm timer. */
226 struct itimerval p_timer[3]; /* Virtual-time timers. */
228 int p_traceflag; /* Kernel trace points. */
229 struct ktrace_node *p_tracenode; /* Trace to vnode. */
231 sigset_t p_siglist; /* Signals arrived but not delivered. */
233 struct vnode *p_textvp; /* Vnode of executable. */
235 unsigned int p_stops; /* procfs event bitmask */
236 unsigned int p_stype; /* procfs stop event type */
237 char p_step; /* procfs stop *once* flag */
238 unsigned char p_pfsflags; /* procfs flags */
239 char p_pad2[2]; /* padding for alignment */
240 struct sigiolst p_sigiolst; /* list of sigio sources */
241 int p_sigparent; /* signal to parent on exit */
242 int p_sig; /* for core dump/debugger XXX */
243 u_long p_code; /* for core dump/debugger XXX */
244 struct klist p_klist; /* knotes attached to this process */
246 struct timeval p_start; /* start time for a process */
248 struct rusage p_ru; /* stats for this proc */
249 struct rusage p_cru; /* sum of stats for reaped children */
251 /* End area that is zeroed on creation. */
252 #define p_endzero p_startcopy
254 /* The following fields are all copied upon creation in fork. */
255 #define p_startcopy p_comm
257 char p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
258 char p_lock; /* Process lock (prevent swap) count. */
259 char p_nice; /* Process "nice" value. */
262 struct pgrp *p_pgrp; /* Pointer to process group. */
264 struct sysentvec *p_sysent; /* System call dispatch information. */
266 struct uprof p_prof; /* Profiling arguments. */
267 struct rtprio p_rtprio; /* Realtime priority. */
268 struct pargs *p_args;
269 /* End area that is copied on creation. */
270 #define p_endcopy p_addr
271 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY) XXX lwp */
273 u_short p_xstat; /* Exit status or last stop signal */
274 u_short p_acflag; /* Accounting flags. */
276 int p_nthreads; /* Number of threads in this process. */
277 int p_nstopped; /* Number of stopped threads. */
278 int p_lasttid; /* Last tid used. */
279 LIST_HEAD(, lwp) p_lwps; /* List of threads in this process. */
280 void *p_aioinfo; /* ASYNC I/O info */
281 int p_wakeup; /* thread id XXX lwp */
282 struct proc *p_peers; /* XXX lwp */
283 struct proc *p_leader; /* XXX lwp */
284 void *p_emuldata; /* process-specific emulator state */
285 struct usched *p_usched; /* Userland scheduling control */
286 struct vkernel *p_vkernel; /* Virtual kernel extension */
287 int p_numposixlocks; /* number of POSIX locks */
289 struct spinlock p_spin; /* Spinlock for LWP access to proc */
292 #define lwp_wchan lwp_thread->td_wchan
293 #define lwp_wmesg lwp_thread->td_wmesg
294 #define p_session p_pgrp->pg_session
295 #define p_pgid p_pgrp->pg_id
298 * Status values. Please note that p_stat doesn't actually take on
299 * synthesized states.
301 #define SIDL 1 /* Process being created by fork. */
302 #define SRUN 2 /* Currently runnable. */
303 #define SSLEEP 3 /* Sleeping on an address. */
304 #define SSTOP 4 /* Synthesized from SSLEEP + P_STOPPED */
305 #define SZOMB 5 /* Synthesized from P_ZOMBIE for eproc only */
306 #define STHREAD 6 /* Synthesized for eproc only */
308 /* These flags are kept in p_flags. */
309 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
310 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
311 #define P_SWAPPEDOUT 0x00004 /* Swapped out of memory */
312 #define P_BREAKTSLEEP 0x00008 /* Event pending, break tsleep on sigcont */
313 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
314 #define P_PROFIL 0x00020 /* Has started profiling. */
315 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
316 #define P_SINTR 0x00080 /* Sleep is interruptible. */
317 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
318 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
319 #define P_STOPPED 0x00400 /* SIGSTOP status */
320 #define P_TRACED 0x00800 /* Debugged process being traced. */
321 #define P_WAITED 0x01000 /* SIGSTOP status was returned by wait3/4 */
322 #define P_WEXIT 0x02000 /* Working on exiting. */
323 #define P_EXEC 0x04000 /* Process called exec. */
325 /* Should probably be changed into a hold count. */
326 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
327 #define P_MAILBOX 0x10000 /* Possible mailbox signal pending */
329 #define P_UPCALLPEND 0x20000 /* an upcall is pending */
331 #define P_SWAPWAIT 0x40000 /* Waiting for a swapin */
332 #define P_ZOMBIE 0x80000 /* Now in a zombied state */
334 /* Marked a kernel thread */
335 #define P_ONRUNQ 0x100000 /* on a user scheduling run queue */
336 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
337 #define P_IDLESWAP 0x400000 /* Swapout was due to idleswap, not load */
338 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
340 #define P_JAILED 0x1000000 /* Process is in jail */
341 #define P_UNUSED0 0x2000000 /* need to restore mask before pause */
342 #define P_UNUSED1 0x4000000 /* have alternate signal stack */
343 #define P_INEXEC 0x8000000 /* Process is in execve(). */
344 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */
345 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */
346 #define P_XCPU 0x40000000 /* SIGXCPU */
348 #define LWP_ALTSTACK 0x0000001 /* have alternate signal stack */
349 #define LWP_OLDMASK 0x0000002 /* need to restore mask before pause */
351 #define FIRST_LWP_IN_PROC(p) LIST_FIRST(&(p)->p_lwps)
352 #define FOREACH_LWP_IN_PROC(lp, p) \
353 LIST_FOREACH((lp), &(p)->p_lwps, lwp_list)
354 #define ONLY_LWP_IN_PROC(p) \
355 (p->p_nthreads != 1 && \
356 (panic("%s: proc %p (pid %d cmd %s) has more than one thread", \
357 __func__, p, p->p_pid, p->p_comm), 1), \
358 FIRST_LWP_IN_PROC(p))
361 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
362 * as it is used to represent "no process group".
364 #define PID_MAX 99999
365 #define NO_PID 100000
367 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
371 #ifdef MALLOC_DECLARE
372 MALLOC_DECLARE(M_SESSION);
373 MALLOC_DECLARE(M_SUBPROC);
374 MALLOC_DECLARE(M_PARGS);
377 /* flags for suser_xxx() */
378 #define PRISON_ROOT 0x1
379 #define NULL_CRED_OKAY 0x2
381 /* Handy macro to determine if p1 can mangle p2 */
383 #define PRISON_CHECK(cr1, cr2) \
384 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
389 extern void stopevent(struct proc*, unsigned int, unsigned int);
390 #define STOPEVENT(p,e,v) \
392 if ((p)->p_stops & (e)) { \
397 /* hold process U-area in memory, normally for ptrace/procfs work */
398 #define PHOLD(p) (++(p)->p_lock)
399 #define PRELE(p) (--(p)->p_lock)
401 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
402 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
403 extern u_long pidhash;
405 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
406 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
407 extern u_long pgrphash;
411 #define SET_CURPROC(p) (curproc = (p))
415 extern struct proc proc0; /* Process slot for swapper. */
416 extern struct lwp lwp0; /* LWP 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;
447 extern struct vm_zone *lwp_zone;
449 int enterpgrp (struct proc *p, pid_t pgid, int mksess);
450 void proc_add_allproc(struct proc *p);
451 void proc_move_allproc_zombie(struct proc *);
452 void proc_remove_zombie(struct proc *);
453 void allproc_scan(int (*callback)(struct proc *, void *), void *data);
454 void zombproc_scan(int (*callback)(struct proc *, void *), void *data);
455 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
456 void updatepcpu(struct lwp *, int, int);
457 int inferior (struct proc *p);
458 int leavepgrp (struct proc *p);
459 void sess_hold(struct session *sp);
460 void sess_rele(struct session *sp);
461 void mi_switch (struct proc *p);
462 void procinit (void);
463 void relscurproc(struct proc *curp);
464 int p_trespass (struct ucred *cr1, struct ucred *cr2);
465 void setrunnable (struct proc *);
466 void clrrunnable (struct proc *);
467 void sleep_gdinit (struct globaldata *);
468 int suser (struct thread *td);
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 lwp *, struct lwp *, int);
477 void cpu_set_fork_handler (struct lwp *, 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_ */