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