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.32 2003/10/16 22:26:42 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>
58 #include <sys/globaldata.h>
60 #include <machine/proc.h> /* Machine-dependent proc substruct. */
63 * One structure allocated per session.
66 int s_count; /* Ref cnt; pgrps in session. */
67 struct proc *s_leader; /* Session leader. */
68 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
69 struct tty *s_ttyp; /* Controlling terminal. */
70 pid_t s_sid; /* Session ID */
71 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
75 * One structure allocated per process group.
78 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
79 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
80 struct session *pg_session; /* Pointer to session. */
81 struct sigiolst pg_sigiolst; /* List of sigio sources. */
82 pid_t pg_id; /* Pgrp id. */
83 int pg_jobc; /* # procs qualifying pgrp for job control */
87 sigset_t ps_sigignore; /* Signals being ignored. */
88 sigset_t ps_sigcatch; /* Signals being caught by user. */
90 struct sigacts *ps_sigacts;
94 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
95 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
98 * pargs, used to hold a copy of the command line, if it had a sane
102 u_int ar_ref; /* Reference count */
103 u_int ar_length; /* Length */
104 u_char ar_args[0]; /* Arguments */
108 * Description of a process.
110 * This structure contains the information needed to manage a thread of
111 * control, known in UN*X as a process; it has references to substructures
112 * containing descriptions of things that the process uses, but may share
113 * with related processes. The process structure and the substructures
114 * are always addressable except for those marked "(PROC ONLY)" below,
115 * which might be addressable only on a processor on which the process
122 TAILQ_ENTRY(proc) p_procq; /* run/sleep queue. */
123 LIST_ENTRY(proc) p_list; /* List of all processes. */
126 struct ucred *p_ucred; /* Process owner's identity. */
127 struct filedesc *p_fd; /* Ptr to open files structure. */
128 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */
129 struct pstats *p_stats; /* Accounting/statistics (PROC ONLY). */
130 struct plimit *p_limit; /* Process limits. */
132 struct vm_object *p_upages_obj;/* Upages object */
136 struct procsig *p_procsig;
137 #define p_sigacts p_procsig->ps_sigacts
138 #define p_sigignore p_procsig->ps_sigignore
139 #define p_sigcatch p_procsig->ps_sigcatch
140 #define p_rlimit p_limit->pl_rlimit
142 int p_flag; /* P_* flags. */
143 char p_stat; /* S* process status. */
146 pid_t p_pid; /* Process identifier. */
147 LIST_ENTRY(proc) p_hash; /* Hash chain. */
148 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
149 struct proc *p_pptr; /* Pointer to parent process. */
150 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
151 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */
153 struct callout_handle p_ithandle; /*
154 * Callout handle for scheduling
157 /* The following fields are all zeroed upon creation in fork. */
158 #define p_startzero p_oppid
160 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
161 int p_dupfd; /* Sideways return value from fdopen. XXX */
163 struct vmspace *p_vmspace; /* Address space. */
166 u_int p_estcpu; /* Time averaged value of p_cpticks. */
167 int p_cpticks; /* Ticks of cpu time. */
168 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
169 u_int p_swtime; /* Time swapped in or out. */
170 u_int p_slptime; /* Time since last blocked. */
172 struct itimerval p_realtimer; /* Alarm timer. */
174 int p_traceflag; /* Kernel trace points. */
175 struct vnode *p_tracep; /* Trace to vnode. */
177 sigset_t p_siglist; /* Signals arrived but not delivered. */
179 struct vnode *p_textvp; /* Vnode of executable. */
181 char p_lock; /* Process lock (prevent swap) count. */
182 u_char p_unused01; /* Which cpu we are on */
183 u_char p_unused02; /* Last cpu we were on */
184 char p_rqindex; /* Run queue index */
186 unsigned int p_stops; /* procfs event bitmask */
187 unsigned int p_stype; /* procfs stop event type */
188 char p_step; /* procfs stop *once* flag */
189 unsigned char p_pfsflags; /* procfs flags */
190 char p_pad3[2]; /* padding for alignment */
191 struct sigiolst p_sigiolst; /* list of sigio sources */
192 int p_sigparent; /* signal to parent on exit */
193 sigset_t p_oldsigmask; /* saved mask from before sigpause */
194 int p_sig; /* for core dump/debugger XXX */
195 u_long p_code; /* for core dump/debugger XXX */
196 struct klist p_klist; /* knotes attached to this process */
198 /* End area that is zeroed on creation. */
199 #define p_endzero p_startcopy
201 /* The following fields are all copied upon creation in fork. */
202 #define p_startcopy p_sigmask
204 sigset_t p_sigmask; /* Current signal mask. */
205 stack_t p_sigstk; /* sp & on stack state variable */
206 u_char p_priority; /* Tracks user sched queue */
207 char p_nice; /* Process "nice" value. */
209 struct pgrp *p_pgrp; /* Pointer to process group. */
211 struct sysentvec *p_sysent; /* System call dispatch information. */
213 struct rtprio p_rtprio; /* Realtime priority. */
214 struct pargs *p_args;
215 /* End area that is copied on creation. */
216 #define p_endcopy p_addr
217 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
218 struct mdproc p_md; /* Any machine-dependent fields. */
220 u_short p_xstat; /* Exit status for wait; also stop signal. */
221 u_short p_acflag; /* Accounting flags. */
222 struct rusage *p_ru; /* Exit information. XXX */
224 int p_nthreads; /* number of threads (only in leader) */
225 void *p_aioinfo; /* ASYNC I/O info */
226 int p_wakeup; /* thread id */
227 struct proc *p_peers;
228 struct proc *p_leader;
229 void *p_emuldata; /* process-specific emulator state data */
230 struct thread *p_thread; /* temporarily embed thread struct in proc */
234 #define p_wchan p_thread->td_wchan
235 #define p_wmesg p_thread->td_wmesg
236 #define p_comm p_thread->td_comm
237 #define p_session p_pgrp->pg_session
238 #define p_pgid p_pgrp->pg_id
242 #define SIDL 1 /* Process being created by fork. */
243 #define SRUN 2 /* Currently runnable. */
244 #define SSLEEP 3 /* Sleeping on an address. */
245 #define SSTOP 4 /* Process debugging or suspension. */
246 #define SZOMB 5 /* Awaiting collection by parent. */
247 #define STHREAD 6 /* Synthesized for eproc only */
249 /* These flags are kept in p_flags. */
250 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
251 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
252 #define P_INMEM 0x00004 /* Loaded into memory. */
253 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
254 #define P_PROFIL 0x00020 /* Has started profiling. */
255 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
256 #define P_SINTR 0x00080 /* Sleep is interruptible. */
257 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
258 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
259 #define P_CURPROC 0x00400 /* 'Current process' on this cpu */
260 #define P_TRACED 0x00800 /* Debugged process being traced. */
261 #define P_WAITED 0x01000 /* Debugging process has waited for child. */
262 #define P_WEXIT 0x02000 /* Working on exiting. */
263 #define P_EXEC 0x04000 /* Process called exec. */
265 /* Should probably be changed into a hold count. */
266 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
267 /* was P_PHYSIO 0x10000 was: Doing physical I/O; use p->p_hold */
269 #define P_UNUSED20000 0x20000
271 #define P_SWAPPING 0x40000 /* Process is being swapped. */
272 #define P_SWAPINREQ 0x80000 /* Swapin request due to wakeup */
274 /* Marked a kernel thread */
275 #define P_ONRUNQ 0x100000 /* on a user scheduling run queue */
276 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
277 #define P_CP_RELEASED 0x400000 /* directly schedule LWKT, ignore user schd */
279 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
281 #define P_JAILED 0x1000000 /* Process is in jail */
282 #define P_OLDMASK 0x2000000 /* need to restore mask before pause */
283 #define P_ALTSTACK 0x4000000 /* have alternate signal stack */
284 #define P_INEXEC 0x8000000 /* Process is in execve(). */
285 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */
289 #ifdef MALLOC_DECLARE
290 MALLOC_DECLARE(M_SESSION);
291 MALLOC_DECLARE(M_SUBPROC);
292 MALLOC_DECLARE(M_ZOMBIE);
293 MALLOC_DECLARE(M_PARGS);
296 /* flags for suser_xxx() */
297 #define PRISON_ROOT 1
299 /* Handy macro to determine if p1 can mangle p2 */
301 #define PRISON_CHECK(cr1, cr2) \
302 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
305 * Handy macro for LISTs.
307 #define FOREACH_PROC_IN_SYSTEM(p) LIST_FOREACH((p), &allproc, p_list)
310 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
311 * as it is used to represent "no process group".
313 #define PID_MAX 99999
314 #define NO_PID 100000
316 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
317 #define SESSHOLD(s) ((s)->s_count++)
318 #define SESSRELE(s) { \
319 if (--(s)->s_count == 0) \
320 FREE(s, M_SESSION); \
326 extern void stopevent(struct proc*, unsigned int, unsigned int);
327 #define STOPEVENT(p,e,v) \
329 if ((p)->p_stops & (e)) { \
334 /* hold process U-area in memory, normally for ptrace/procfs work */
336 if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
339 #define PRELE(p) (--(p)->p_lock)
341 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
342 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
343 extern u_long pidhash;
345 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
346 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
347 extern u_long pgrphash;
351 #define SET_CURPROC(p) (curproc = (p))
355 extern struct proc proc0; /* Process slot for swapper. */
356 extern struct thread thread0; /* Thread slot for swapper. */
357 extern int hogticks; /* Limit on kernel cpu hogs. */
358 extern int nprocs, maxproc; /* Current and max number of procs. */
359 extern int maxprocperuid; /* Max procs per uid. */
360 extern int sched_quantum; /* Scheduling quantum in ticks */
362 LIST_HEAD(proclist, proc);
363 extern struct proclist allproc; /* List of all processes. */
364 extern struct proclist zombproc; /* List of zombie processes. */
365 extern struct proc *initproc; /* Process slot for init */
366 extern struct thread *pagethread, *updatethread;
368 #define NQS 32 /* 32 run queues. */
369 TAILQ_HEAD(rq, proc);
370 extern struct rq queues[];
371 extern struct rq rtqueues[];
372 extern struct rq idqueues[];
373 extern int whichqs; /* Bit mask summary of non-empty Q's. */
374 extern int whichrtqs; /* Bit mask summary of non-empty Q's. */
375 extern int whichidqs; /* Bit mask summary of non-empty Q's. */
378 * XXX macros for scheduler. Shouldn't be here, but currently needed for
379 * bounding the dubious p_estcpu inheritance in wait1().
380 * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in
381 * the range 100-256 Hz (approximately).
383 #define ESTCPULIM(e) \
384 min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * PRIO_MAX - PPQ) + \
385 INVERSE_ESTCPU_WEIGHT - 1)
386 #define INVERSE_ESTCPU_WEIGHT 8 /* 1 / (priorities per estcpu level) */
387 #define NICE_WEIGHT 2 /* priorities per nice level */
388 #define PPQ (128 / NQS) /* priorities per queue */
390 extern u_long ps_arg_cache_limit;
391 extern int ps_argsopen;
392 extern int ps_showallprocs;
394 struct proc *pfind (pid_t); /* Find process by id. */
395 struct pgrp *pgfind (pid_t); /* Find process group by id. */
396 struct proc *zpfind (pid_t); /* Find zombie process by id. */
400 extern struct vm_zone *proc_zone;
402 int enterpgrp (struct proc *p, pid_t pgid, int mksess);
403 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
404 int inferior (struct proc *p);
405 int leavepgrp (struct proc *p);
406 void mi_switch (void);
407 void procinit (void);
408 void relscurproc(struct proc *curp);
409 int p_trespass (struct ucred *cr1, struct ucred *cr2);
410 void resetpriority (struct proc *);
411 int roundrobin_interval (void);
412 void resched_cpus(u_int32_t mask);
413 void schedclock (struct proc *);
414 void setrunnable (struct proc *);
415 void clrrunnable (struct proc *, int stat);
416 void setrunqueue (struct proc *);
417 void sleepinit (void);
418 int suser (struct thread *td);
419 int suser_proc (struct proc *p);
420 int suser_cred (struct ucred *cred, int flag);
421 void remrunqueue (struct proc *);
422 void release_curproc (struct proc *curp, int force);
423 void acquire_curproc (struct proc *curp);
424 void cpu_heavy_switch (struct thread *);
425 void cpu_lwkt_switch (struct thread *);
426 void unsleep (struct thread *);
428 void cpu_proc_exit (void) __dead2;
429 void cpu_thread_exit (void) __dead2;
430 void exit1 (int) __dead2;
431 void cpu_fork (struct proc *, struct proc *, int);
432 void cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
433 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
434 int fork1 (struct proc *, int, struct proc **);
435 void start_forked_proc (struct proc *, struct proc *);
436 int trace_req (struct proc *);
437 void cpu_proc_wait (struct proc *);
438 void cpu_thread_wait (struct thread *);
439 int cpu_coredump (struct thread *, struct vnode *, struct ucred *);
440 void setsugid (void);
441 void faultin (struct proc *p);
442 void sched_thread_init(void);
444 u_int32_t procrunnable (void);
448 #endif /* !_SYS_PROC_H_ */