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.58 2005/06/25 21:18:42 dillon Exp $
46 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
47 #error "Userland must include sys/user.h instead of sys/proc.h"
50 #include <sys/callout.h> /* For struct callout_handle. */
51 #include <sys/filedesc.h>
52 #include <sys/queue.h>
53 #include <sys/rtprio.h> /* For struct rtprio. */
54 #include <sys/signal.h>
56 #include <sys/time.h> /* For structs itimerval, timeval. */
58 #include <sys/ucred.h>
59 #include <sys/event.h> /* For struct klist */
60 #include <sys/thread.h>
61 #include <sys/varsym.h>
62 #include <sys/upcall.h>
64 #include <sys/globaldata.h>
66 #include <sys/usched.h>
67 #include <machine/proc.h> /* Machine-dependent proc substruct. */
70 * One structure allocated per session.
73 int s_count; /* Ref cnt; pgrps in session. */
74 struct proc *s_leader; /* Session leader. */
75 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
76 struct tty *s_ttyp; /* Controlling terminal. */
77 pid_t s_sid; /* Session ID */
78 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
82 * One structure allocated per process group.
85 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
86 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
87 struct session *pg_session; /* Pointer to session. */
88 struct sigiolst pg_sigiolst; /* List of sigio sources. */
89 pid_t pg_id; /* Pgrp id. */
90 int pg_jobc; /* # procs qualifying pgrp for job control */
94 sigset_t ps_sigignore; /* Signals being ignored. */
95 sigset_t ps_sigcatch; /* Signals being caught by user. */
97 struct sigacts *ps_sigacts;
101 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
102 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
105 * pargs, used to hold a copy of the command line, if it had a sane
109 u_int ar_ref; /* Reference count */
110 u_int ar_length; /* Length */
111 u_char ar_args[0]; /* Arguments */
115 * Description of a process.
117 * This structure contains the information needed to manage a thread of
118 * control, known in UN*X as a process; it has references to substructures
119 * containing descriptions of things that the process uses, but may share
120 * with related processes. The process structure and the substructures
121 * are always addressable except for those marked "(PROC ONLY)" below,
122 * which might be addressable only on a processor on which the process
125 * NOTE! The process start time is stored in the thread structure associated
126 * with the process. If the process is a Zombie, then this field will be
127 * inaccessible due to the thread structure being free'd in kern_wait1().
133 TAILQ_ENTRY(proc) p_procq; /* run/sleep queue. */
134 LIST_ENTRY(proc) p_list; /* List of all processes. */
137 struct ucred *p_ucred; /* Process owner's identity. */
138 struct filedesc *p_fd; /* Ptr to open files structure. */
139 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */
140 struct pstats *p_stats; /* Accounting/statistics (PROC ONLY). */
141 struct plimit *p_limit; /* Process limits. */
143 struct procsig *p_procsig;
144 #define p_sigacts p_procsig->ps_sigacts
145 #define p_sigignore p_procsig->ps_sigignore
146 #define p_sigcatch p_procsig->ps_sigcatch
147 #define p_rlimit p_limit->pl_rlimit
149 int p_flag; /* P_* flags. */
150 char p_stat; /* S* process status. */
153 pid_t p_pid; /* Process identifier. */
154 LIST_ENTRY(proc) p_hash; /* Hash chain. */
155 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
156 struct proc *p_pptr; /* Pointer to parent process. */
157 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
158 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */
159 struct callout p_ithandle; /* for scheduling p_realtimer */
160 struct varsymset p_varsymset;
162 /* The following fields are all zeroed upon creation in fork. */
163 #define p_startzero p_oppid
165 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
166 int p_dupfd; /* Sideways return value from fdopen. XXX */
168 struct vmspace *p_vmspace; /* Address space. */
171 u_int p_estcpu; /* Time averaged value of p_cpticks. */
172 u_int p_estcpu_fork; /* estcpu as of fork, used in batch detect */
173 int p_cpticks; /* Ticks of cpu time. */
174 fixpt_t p_pctcpu; /* %cpu for this process */
175 u_int p_swtime; /* Time swapped in or out. */
176 u_int p_slptime; /* Time since last blocked. */
178 struct itimerval p_realtimer; /* Alarm timer. */
180 int p_traceflag; /* Kernel trace points. */
181 struct vnode *p_tracep; /* Trace to vnode. */
183 sigset_t p_siglist; /* Signals arrived but not delivered. */
185 struct vnode *p_textvp; /* Vnode of executable. */
187 char p_lock; /* Process lock (prevent swap) count. */
188 short p_priority; /* overall priority (lower==better) */
189 char p_rqindex; /* Run queue index */
191 unsigned int p_stops; /* procfs event bitmask */
192 unsigned int p_stype; /* procfs stop event type */
193 char p_step; /* procfs stop *once* flag */
194 unsigned char p_pfsflags; /* procfs flags */
195 char p_pad3[2]; /* padding for alignment */
196 struct sigiolst p_sigiolst; /* list of sigio sources */
197 int p_sigparent; /* signal to parent on exit */
198 sigset_t p_oldsigmask; /* saved mask from before sigpause */
199 int p_sig; /* for core dump/debugger XXX */
200 u_long p_code; /* for core dump/debugger XXX */
201 struct klist p_klist; /* knotes attached to this process */
203 /* End area that is zeroed on creation. */
204 #define p_endzero p_startcopy
206 /* The following fields are all copied upon creation in fork. */
207 #define p_startcopy p_sigmask
209 sigset_t p_sigmask; /* Current signal mask. */
210 stack_t p_sigstk; /* sp & on stack state variable */
211 char p_interactive; /* long term interactivity par-0 */
212 char p_nice; /* Process "nice" value. */
214 struct pgrp *p_pgrp; /* Pointer to process group. */
216 struct sysentvec *p_sysent; /* System call dispatch information. */
218 struct rtprio p_rtprio; /* Realtime priority. */
219 struct pargs *p_args;
220 /* End area that is copied on creation. */
221 #define p_endcopy p_addr
222 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY) */
223 struct mdproc p_md; /* Any machine-dependent fields. */
225 u_short p_xstat; /* Exit status or last stop signal */
226 u_short p_acflag; /* Accounting flags. */
227 struct rusage *p_ru; /* Exit information. XXX */
229 int p_nthreads; /* number of threads (only in leader) */
230 void *p_aioinfo; /* ASYNC I/O info */
231 int p_wakeup; /* thread id */
232 struct proc *p_peers;
233 struct proc *p_leader;
234 void *p_emuldata; /* process-specific emulator state */
235 struct thread *p_thread; /* backpointer to proc's thread */
236 struct upcall *p_upcall; /* REGISTERED USERLAND POINTER! */
237 struct usched *p_usched; /* Userland scheduling control */
238 int p_numposixlocks; /* number of POSIX locks */
239 TAILQ_HEAD(, sysmsg) p_sysmsgq; /* Recorded asynch system calls */
240 int p_num_sysmsg; /* Number of asynch messages running */
244 #define p_wchan p_thread->td_wchan
245 #define p_wmesg p_thread->td_wmesg
246 #define p_comm p_thread->td_comm
247 #define p_session p_pgrp->pg_session
248 #define p_pgid p_pgrp->pg_id
252 #define SIDL 1 /* Process being created by fork. */
253 #define SRUN 2 /* Currently runnable. */
254 #define SSLEEP 3 /* Sleeping on an address. */
255 #define SSTOP 4 /* Process debugging or suspension. */
256 #define SZOMB 5 /* Awaiting collection by parent. */
257 #define STHREAD 6 /* Synthesized for eproc only */
259 /* These flags are kept in p_flags. */
260 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
261 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
262 #define P_INMEM 0x00004 /* Loaded into memory. */
263 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
264 #define P_PROFIL 0x00020 /* Has started profiling. */
265 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
266 #define P_SINTR 0x00080 /* Sleep is interruptible. */
267 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
268 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
269 #define P_UNUSED00400 0x00400
270 #define P_TRACED 0x00800 /* Debugged process being traced. */
271 #define P_WAITED 0x01000 /* Debugging process has waited for child. */
272 #define P_WEXIT 0x02000 /* Working on exiting. */
273 #define P_EXEC 0x04000 /* Process called exec. */
275 /* Should probably be changed into a hold count. */
276 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
277 /* was P_PHYSIO 0x10000 was: Doing physical I/O; use p->p_hold */
279 #define P_UPCALLPEND 0x20000 /* an upcall is pending */
281 #define P_SWAPPING 0x40000 /* Process is being swapped. */
282 #define P_SWAPINREQ 0x80000 /* Swapin request due to wakeup */
284 /* Marked a kernel thread */
285 #define P_ONRUNQ 0x100000 /* on a user scheduling run queue */
286 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
287 #define P_UNUSED400000 0x400000
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_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */
295 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */
299 #ifdef MALLOC_DECLARE
300 MALLOC_DECLARE(M_SESSION);
301 MALLOC_DECLARE(M_SUBPROC);
302 MALLOC_DECLARE(M_ZOMBIE);
303 MALLOC_DECLARE(M_PARGS);
306 /* flags for suser_xxx() */
307 #define PRISON_ROOT 0x1
308 #define NULL_CRED_OKAY 0x2
310 /* Handy macro to determine if p1 can mangle p2 */
312 #define PRISON_CHECK(cr1, cr2) \
313 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
316 * Handy macro for LISTs.
318 #define FOREACH_PROC_IN_SYSTEM(p) LIST_FOREACH((p), &allproc, p_list)
321 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
322 * as it is used to represent "no process group".
324 #define PID_MAX 99999
325 #define NO_PID 100000
327 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
332 extern void stopevent(struct proc*, unsigned int, unsigned int);
333 #define STOPEVENT(p,e,v) \
335 if ((p)->p_stops & (e)) { \
340 /* hold process U-area in memory, normally for ptrace/procfs work */
342 if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
345 #define PRELE(p) (--(p)->p_lock)
347 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
348 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
349 extern u_long pidhash;
351 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
352 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
353 extern u_long pgrphash;
357 #define SET_CURPROC(p) (curproc = (p))
361 extern struct proc proc0; /* Process slot for swapper. */
362 extern struct thread thread0; /* Thread slot for swapper. */
363 extern int hogticks; /* Limit on kernel cpu hogs. */
364 extern int nprocs, maxproc; /* Current and max number of procs. */
365 extern int maxprocperuid; /* Max procs per uid. */
366 extern int sched_quantum; /* Scheduling quantum in ticks */
368 LIST_HEAD(proclist, proc);
369 extern struct proclist allproc; /* List of all processes. */
370 extern struct proclist zombproc; /* List of zombie processes. */
371 extern struct proc *initproc; /* Process slot for init */
372 extern struct thread *pagethread, *updatethread;
374 #define NQS 32 /* 32 run queues. */
375 TAILQ_HEAD(rq, proc);
378 * Scheduler estcpu macros.
380 * p_priority = NICE_ADJUST(p->p_nice - PRIO_MIN) +
381 * p->p_estcpu / ESTCPURAMP;
383 * NICE_WEIGHT determines the p_estcpu overlap between nice levels. It
384 * cannot exceed 3.0. A value of 2.0 gives us a nice small overlap between
385 * nice -20 and nice +0. A value of 3.0 reduces the overlap while a value
386 * of 1.0 increases the overlap.
388 * ESTCPURAMP determines how slowly estcpu effects the process priority.
389 * Higher numbers result in slower ramp-up times because estcpu is incremented
390 * once per scheduler tick and maxes out at ESTCPULIM.
392 * ESTCPULIM = (127 - 2 * 40) * 8 = 376
394 * NOTE: ESTCPUVFREQ is the 'virtual' estcpu accumulation frequency, whereas
395 * ESTCPUFREQ is the actual interrupt rate. The ratio is used to scale
396 * both the ramp-up and the decay calculations in kern_synch.c.
399 #define ESTCPURAMP 8 /* higher equals slower */
400 #define NICE_ADJUST(value) (((unsigned int)(NICE_WEIGHT * 128) * (value)) / 128)
401 #define ESTCPUMAX ((MAXPRI - NICE_ADJUST(PRIO_MAX - PRIO_MIN)) * ESTCPURAMP)
402 #define ESTCPULIM(v) min((v), ESTCPUMAX)
403 #define ESTCPUFREQ 20 /* estcpu update frequency */
404 #define ESTCPUVFREQ 40 /* virtual freq controls ramp*/
405 #define NICE_WEIGHT 2.0 /* priorities per nice level */
406 #define PPQ ((MAXPRI + 1) / NQS) /* priorities per queue */
408 extern u_long ps_arg_cache_limit;
409 extern int ps_argsopen;
410 extern int ps_showallprocs;
412 struct proc *pfind (pid_t); /* Find process by id. */
413 struct pgrp *pgfind (pid_t); /* Find process group by id. */
414 struct proc *zpfind (pid_t); /* Find zombie process by id. */
418 extern struct vm_zone *proc_zone;
420 int enterpgrp (struct proc *p, pid_t pgid, int mksess);
421 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
422 int inferior (struct proc *p);
423 int leavepgrp (struct proc *p);
424 void sess_hold(struct session *sp);
425 void sess_rele(struct session *sp);
426 void mi_switch (struct proc *p);
427 void procinit (void);
428 void relscurproc(struct proc *curp);
429 int p_trespass (struct ucred *cr1, struct ucred *cr2);
430 void resetpriority (struct proc *);
431 int roundrobin_interval (void);
432 void resched_cpus(u_int32_t mask);
433 void schedulerclock (void *dummy);
434 void setrunnable (struct proc *);
435 void clrrunnable (struct proc *, int stat);
436 void sleepinit (void);
437 int suser (struct thread *td);
438 int suser_proc (struct proc *p);
439 int suser_cred (struct ucred *cred, int flag);
440 void cpu_heavy_switch (struct thread *);
441 void cpu_lwkt_switch (struct thread *);
442 void unsleep (struct thread *);
444 void cpu_proc_exit (void) __dead2;
445 void cpu_thread_exit (void) __dead2;
446 void exit1 (int) __dead2;
447 void cpu_fork (struct proc *, struct proc *, int);
448 void cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
449 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
450 int fork1 (struct proc *, int, struct proc **);
451 void start_forked_proc (struct proc *, struct proc *);
452 int trace_req (struct proc *);
453 void cpu_proc_wait (struct proc *);
454 void cpu_thread_wait (struct thread *);
455 int cpu_coredump (struct thread *, struct vnode *, struct ucred *);
456 void setsugid (void);
457 void faultin (struct proc *p);
459 u_int32_t procrunnable (void);
463 #endif /* !_SYS_PROC_H_ */