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 $
45 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
47 #error "Userland must include sys/user.h instead of sys/proc.h"
51 #include <sys/callout.h> /* For struct callout_handle. */
52 #include <sys/filedesc.h>
53 #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/eventvar.h>
64 #include <sys/sysent.h> /* For struct sysentvec */
65 #include <sys/thread.h>
66 #include <sys/varsym.h>
67 #include <sys/upcall.h>
68 #include <sys/resourcevar.h>
70 #include <sys/globaldata.h>
72 #include <sys/systimer.h>
73 #include <sys/iosched.h>
74 #include <sys/usched.h>
75 #include <machine/proc.h> /* Machine-dependent proc substruct. */
76 #include <machine/atomic.h> /* Machine-dependent proc substruct. */
77 #include <sys/signalvar.h>
79 LIST_HEAD(proclist, proc);
80 LIST_HEAD(lwplist, lwp);
83 RB_HEAD(lwp_rb_tree, lwp);
84 RB_PROTOTYPE2(lwp_rb_tree, lwp, u.lwp_rbnode, rb_lwp_compare, lwpid_t);
87 * One structure allocated per session.
90 int s_count; /* Ref cnt; pgrps in session. */
91 struct proc *s_leader; /* Session leader. */
92 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
93 struct tty *s_ttyp; /* Controlling terminal. */
94 pid_t s_sid; /* Session ID */
95 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
99 * One structure allocated per process group.
102 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
103 struct proclist pg_members; /* Pointer to pgrp members. */
104 struct session *pg_session; /* Pointer to session. */
105 struct sigiolst pg_sigiolst; /* List of sigio sources. */
106 pid_t pg_id; /* Pgrp id. */
107 int pg_jobc; /* # procs qualifying pgrp for job control */
109 struct lwkt_token pg_token;
113 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
114 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
117 * pargs, used to hold a copy of the command line, if it had a sane
121 u_int ar_ref; /* Reference count */
122 u_int ar_length; /* Length */
123 u_char ar_args[0]; /* Arguments */
127 * Description of a process.
129 * This structure contains the information needed to manage a thread of
130 * control, known in UN*X as a process; it has references to substructures
131 * containing descriptions of things that the process uses, but may share
132 * with related processes. The process structure and the substructures
133 * are always addressable except for those marked "(PROC ONLY)" below,
134 * which might be addressable only on a processor on which the process
137 * NOTE! The process start time is stored in the thread structure associated
138 * with the process. If the process is a Zombie, then this field will be
139 * inaccessible due to the thread structure being free'd in kern_wait1().
145 struct vmspace_entry;
162 TAILQ_ENTRY(lwp) lwp_procq; /* run/sleep queue. */
164 RB_ENTRY(lwp) lwp_rbnode; /* RB tree node - lwp in proc */
165 LIST_ENTRY(lwp) lwp_reap_entry; /* reaper list */
168 struct proc *lwp_proc; /* Link to our proc. */
169 struct vmspace *lwp_vmspace; /* Inherited from p_vmspace */
170 struct vkernel_lwp *lwp_vkernel;/* VKernel support, lwp part */
172 lwpid_t lwp_tid; /* Our thread id */
174 u_int lwp_flags; /* LWP_* flags */
175 u_int lwp_mpflags; /* LWP_MP_* flags */
176 enum lwpstat lwp_stat; /* LS* lwp status */
177 int lwp_lock; /* lwp lock (prevent destruct) count */
179 int lwp_dupfd; /* Sideways return value from fdopen */
182 * The following two fields are marked XXX since (at least) the
183 * 4.4BSD-Lite2 import. I can only guess the reason: It is ugly.
184 * These fields are used to pass the trap code from trapsignal() to
185 * postsig(), which gets called later from userret().
187 * The correct "fix" for these XXX is to convert our signal system
188 * to use signal queues, where each signal can carry its own meta
191 int lwp_sig; /* for core dump/debugger XXX */
192 u_long lwp_code; /* for core dump/debugger XXX */
197 sysclock_t lwp_cpticks; /* cpu used in sched clock ticks */
198 sysclock_t lwp_cpbase; /* Measurement base */
199 fixpt_t lwp_pctcpu; /* %cpu for this process */
200 u_int lwp_slptime; /* Time since last blocked. */
202 int lwp_traceflag; /* Kernel trace points. */
204 struct rusage lwp_ru; /* stats for this lwp */
206 union usched_data lwp_usdata; /* User scheduler specific */
208 #define lwp_startcopy lwp_cpumask
209 cpumask_t lwp_cpumask;
210 sigset_t lwp_siglist; /* Signals arrived but not delivered. */
211 sigset_t lwp_oldsigmask; /* saved mask from before sigpause */
212 sigset_t lwp_sigmask; /* Current signal mask. */
213 stack_t lwp_sigstk; /* sp & on stack state variable */
215 struct rtprio lwp_rtprio; /* Realtime priority. */
216 #define lwp_endcopy lwp_md
218 struct mdproc lwp_md; /* Any machine-dependent fields. */
220 struct thread *lwp_thread; /* backpointer to proc's thread */
221 struct upcall *lwp_upcall; /* REGISTERED USERLAND POINTER! */
222 struct kqueue lwp_kqueue; /* for select/poll */
223 u_int lwp_kqueue_serial;
224 struct lwkt_token lwp_token; /* per-lwp token for signal/state */
225 struct spinlock lwp_spin; /* spinlock for signal handling */
229 LIST_ENTRY(proc) p_list; /* List of all processes. */
232 struct ucred *p_ucred; /* Process owner's identity. */
233 struct filedesc *p_fd; /* Ptr to open files structure. */
234 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */
235 struct plimit *p_limit; /* Process limits. */
236 struct pstats *p_stats;
237 u_int p_mqueue_cnt; /* Count of open mqueues. */
239 struct sigacts *p_sigacts;
240 #define p_sigignore p_sigacts->ps_sigignore
241 #define p_sigcatch p_sigacts->ps_sigcatch
242 #define p_rlimit p_limit->pl_rlimit
244 int p_flags; /* P_* flags. */
245 enum procstat p_stat; /* S* process status. */
248 pid_t p_pid; /* Process identifier. */
249 LIST_ENTRY(proc) p_hash; /* Hash chain. */
250 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
251 struct proc *p_pptr; /* Pointer to parent process. */
252 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
253 struct proclist p_children; /* Pointer to list of children. */
254 struct callout p_ithandle; /* for scheduling p_realtimer */
255 struct varsymset p_varsymset;
256 struct iosched_data p_iosdata; /* Dynamic I/O scheduling data */
258 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
260 struct vmspace *p_vmspace; /* Current address space. */
262 unsigned int p_swtime; /* Time swapped in or out */
264 struct itimerval p_realtimer; /* Alarm timer. */
265 struct itimerval p_timer[3]; /* Virtual-time timers. */
267 int p_traceflag; /* Kernel trace points. */
268 struct ktrace_node *p_tracenode; /* Trace to vnode. */
270 sigset_t p_siglist; /* Signals arrived but not delivered. */
272 struct vnode *p_textvp; /* Vnode of executable. */
273 struct nchandle p_textnch; /* namecache handle of executable. */
275 unsigned int p_stops; /* procfs event bitmask */
276 unsigned int p_stype; /* procfs stop event type */
277 char p_step; /* procfs stop *once* flag */
278 unsigned char p_pfsflags; /* procfs flags */
279 char p_pad2[2]; /* padding for alignment */
280 struct sigiolst p_sigiolst; /* list of sigio sources */
281 int p_sigparent; /* signal to parent on exit */
282 struct klist p_klist; /* knotes attached to this process */
284 struct timeval p_start; /* start time for a process */
286 struct rusage p_ru; /* stats for this proc */
287 struct rusage p_cru; /* sum of stats for reaped children */
288 void *p_dsched_priv1;
290 /* The following fields are all copied upon creation in fork. */
291 #define p_startcopy p_comm
293 char p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
294 char p_pad3; /* Process lock (prevent destruct) count. */
295 char p_nice; /* Process "nice" value. */
297 int p_osrel; /* release date for binary ELF note */
299 struct pgrp *p_pgrp; /* Pointer to process group. */
301 struct sysentvec *p_sysent; /* System call dispatch information. */
303 struct uprof p_prof; /* Profiling arguments. */
304 struct rtprio p_rtprio; /* Realtime priority. */
305 struct pargs *p_args;
306 u_short p_xstat; /* Exit status or last stop signal */
309 void *p_dsched_priv2;
310 /* End area that is copied on creation. */
311 #define p_endcopy p_dsched_priv2
312 u_short p_acflag; /* Accounting flags. */
314 int p_lock; /* Prevent proc destruction */
315 int p_nthreads; /* Number of threads in this process. */
316 int p_nstopped; /* Number of stopped threads. */
317 int p_lasttid; /* Last tid used. */
318 struct lwp_rb_tree p_lwp_tree; /* RB tree of LWPs for this process */
319 void *p_aioinfo; /* ASYNC I/O info */
320 int p_wakeup; /* thread id XXX lwp */
321 struct proc *p_peers; /* XXX lwp */
322 struct proc *p_leader; /* XXX lwp */
323 void *p_emuldata; /* process-specific emulator state */
324 struct usched *p_usched; /* Userland scheduling control */
325 struct vkernel_proc *p_vkernel; /* VKernel support, proc part */
326 int p_numposixlocks; /* number of POSIX locks */
327 void (*p_userret)(void);/* p: return-to-user hook */
329 struct spinlock p_spin; /* Spinlock for LWP access to proc */
330 struct lwkt_token p_token; /* Token for LWP access to proc */
333 #define lwp_wchan lwp_thread->td_wchan
334 #define lwp_wmesg lwp_thread->td_wmesg
335 #define p_session p_pgrp->pg_session
336 #define p_pgid p_pgrp->pg_id
338 /* These flags are kept in p_flags. */
339 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock */
340 #define P_CONTROLT 0x00002 /* Has a controlling terminal */
341 #define P_SWAPPEDOUT 0x00004 /* Swapped out of memory */
342 #define P_UNUSED3 0x00008
343 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit */
344 #define P_PROFIL 0x00020 /* Has started profiling */
345 #define P_UNUSED5 0x00040 /* was: Selecting; wakeup/waiting danger */
346 #define P_UNUSED4 0x00080 /* was: Sleep is interruptible */
347 #define P_SUGID 0x00100 /* Had set id privileges since last exec */
348 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping */
349 #define P_UNUSED2 0x00400 /* was: SIGSTOP status */
350 #define P_TRACED 0x00800 /* Debugged process being traced */
351 #define P_WAITED 0x01000 /* SIGSTOP status was returned by wait3/4 */
352 #define P_WEXIT 0x02000 /* Working on exiting (master exit) */
353 #define P_EXEC 0x04000 /* Process called exec */
354 #define P_CONTINUED 0x08000 /* Proc has continued from a stopped state */
356 #define P_UNUSED16 0x00010000
357 #define P_UPCALLPEND 0x00020000 /* an upcall is pending */
359 #define P_SWAPWAIT 0x00040000 /* Waiting for a swapin */
360 #define P_UNUSED19 0x00080000 /* was: Now in a zombied state */
362 /* Marked a kernel thread */
363 #define P_UNUSED20 0x00100000 /* was: on a user scheduling run queue */
364 #define P_KTHREADP 0x00200000 /* Process is really a kernel thread */
365 #define P_IDLESWAP 0x00400000 /* Swapout was due to idleswap, not load */
367 #define P_JAILED 0x01000000 /* Process is in jail */
368 #define P_SIGVTALRM 0x02000000 /* signal SIGVTALRM pending due to itimer */
369 #define P_SIGPROF 0x04000000 /* signal SIGPROF pending due to itimer */
370 #define P_INEXEC 0x08000000 /* Process is in execve(). */
371 #define P_UNUSED28 0x10000000
372 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */
373 #define P_XCPU 0x40000000 /* SIGXCPU */
375 #define LWP_ALTSTACK 0x0000001 /* have alternate signal stack */
376 #define LWP_OLDMASK 0x0000002 /* need to restore mask before pause */
377 #define LWP_SINTR 0x0000008 /* Sleep is interruptible. */
378 #define LWP_SELECT 0x0000010 /* Selecting; wakeup/waiting danger. */
379 #define LWP_UNUSED20 0x0000020
380 #define LWP_UNUSED40 0x0000040
381 #define LWP_UNUSED80 0x0000080
382 #define LWP_PASSIVE_ACQ 0x0000100 /* Passive acquire cpu (see kern_switch) */
383 #define LWP_PAGING 0x0000200 /* Currently in vm_fault */
386 * LWP_MP_WSTOP: When set the thread will stop prior to return to userland
387 * and has been counted in the process stop-threads-count, but
388 * may still be running in kernel-land.
390 * LWP_MP_WEXIT: When set the thread has been asked to exit and will not return
391 * to userland. p_nthreads will not be decremented until the
392 * thread has actually exited.
394 #define LWP_MP_ONRUNQ 0x0000001 /* on a user scheduling run queue */
395 #define LWP_MP_WEXIT 0x0000002 /* working on exiting */
396 #define LWP_MP_WSTOP 0x0000004 /* working on stopping */
398 #define FIRST_LWP_IN_PROC(p) RB_FIRST(lwp_rb_tree, &(p)->p_lwp_tree)
399 #define FOREACH_LWP_IN_PROC(lp, p) \
400 RB_FOREACH(lp, lwp_rb_tree, &(p)->p_lwp_tree)
401 #define ONLY_LWP_IN_PROC(p) \
402 (p->p_nthreads != 1 && \
403 (panic("%s: proc %p (pid %d cmd %s) has more than one thread", \
404 __func__, p, p->p_pid, p->p_comm), 1), \
405 RB_ROOT(&p->p_lwp_tree))
408 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
409 * as it is used to represent "no process group".
411 #define PID_MAX 99999
412 #define NO_PID 100000
414 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
418 #ifdef MALLOC_DECLARE
419 MALLOC_DECLARE(M_SESSION);
420 MALLOC_DECLARE(M_PROC);
421 MALLOC_DECLARE(M_LWP);
422 MALLOC_DECLARE(M_SUBPROC);
423 MALLOC_DECLARE(M_PARGS);
426 /* for priv_check_cred() */
427 #define NULL_CRED_OKAY 0x2
429 /* Handy macro to determine if p1 can mangle p2 */
431 #define PRISON_CHECK(cr1, cr2) \
432 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
437 extern void stopevent(struct proc*, unsigned int, unsigned int);
438 #define STOPEVENT(p,e,v) \
440 if ((p)->p_stops & (e)) { \
446 * Hold process in memory, don't destruct, used by ktrace, procfs, sigio,
447 * and signaling code (e.g. ksignal()).
451 #define PHOLD(p) phold((p))
452 #define PRELE(p) prele((p))
453 #define PSTALL(p, msg, n) \
454 do { if ((p)->p_lock > (n)) pstall((p), (msg), (n)); } while (0)
457 * Hold lwp in memory, don't destruct, normally for ptrace/procfs work
458 * atomic ops because they can occur from an IPI.
461 #define LWPHOLD(lp) atomic_add_int(&(lp)->lwp_lock, 1)
462 #define LWPRELE(lp) atomic_add_int(&(lp)->lwp_lock, -1)
464 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
465 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
466 extern u_long pidhash;
468 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
469 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
470 extern u_long pgrphash;
474 #define SET_CURPROC(p) (curproc = (p))
478 extern struct proc proc0; /* Process slot for swapper. */
479 extern struct lwp lwp0; /* LWP slot for swapper. */
480 extern struct thread thread0; /* Thread slot for swapper. */
481 extern int hogticks; /* Limit on kernel cpu hogs. */
482 extern int nprocs, maxproc; /* Current and max number of procs. */
483 extern int maxprocperuid; /* Max procs per uid. */
484 extern int sched_quantum; /* Scheduling quantum in ticks */
486 extern struct proclist allproc; /* List of all processes. */
487 extern struct proclist zombproc; /* List of zombie processes. */
488 extern struct proc *initproc; /* Process slot for init */
489 extern struct thread *pagethread, *updatethread;
492 * Scheduler independant variables. The primary scheduler polling frequency,
493 * the maximum ESTCPU value, and the weighting factor for nice values. A
494 * cpu bound program's estcpu will increase to ESTCPUMAX - 1.
496 #define ESTCPUFREQ 50
498 extern u_long ps_arg_cache_limit;
499 extern int ps_argsopen;
500 extern int ps_showallprocs;
502 struct proc *pfind (pid_t); /* Find process by id w/ref */
503 struct proc *pfindn (pid_t); /* Find process by id wo/ref */
504 struct pgrp *pgfind (pid_t); /* Find process group by id w/ref */
505 struct proc *zpfind (pid_t); /* Find zombie process by id w/ref */
506 void pgref (struct pgrp *); /* Ref pgrp preventing disposal */
507 void pgrel (struct pgrp *); /* Deref pgrp & dispose on 1->0 trans */
512 int enterpgrp (struct proc *p, pid_t pgid, int mksess);
513 void proc_add_allproc(struct proc *p);
514 void proc_move_allproc_zombie(struct proc *);
515 void proc_remove_zombie(struct proc *);
516 void allproc_scan(int (*callback)(struct proc *, void *), void *data);
517 void alllwp_scan(int (*callback)(struct lwp *, void *), void *data);
518 void zombproc_scan(int (*callback)(struct proc *, void *), void *data);
519 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
520 void updatepcpu(struct lwp *, int, int);
521 int inferior (struct proc *p);
522 int leavepgrp (struct proc *p);
523 void sess_hold(struct session *sp);
524 void sess_rele(struct session *sp);
525 void procinit (void);
526 void relscurproc(struct proc *curp);
527 int p_trespass (struct ucred *cr1, struct ucred *cr2);
528 void setrunnable (struct lwp *);
529 void proc_stop (struct proc *);
530 void proc_unstop (struct proc *);
531 void sleep_gdinit (struct globaldata *);
532 int suser (struct thread *td);
533 int suser_cred (struct ucred *cred, int flag);
534 thread_t cpu_heavy_switch (struct thread *);
535 thread_t cpu_lwkt_switch (struct thread *);
537 void cpu_lwp_exit (void) __dead2;
538 void cpu_thread_exit (void) __dead2;
539 void lwp_exit (int masterexit) __dead2;
540 void lwp_dispose (struct lwp *);
541 int killalllwps (int);
542 void exit1 (int) __dead2;
543 void cpu_fork (struct lwp *, struct lwp *, int);
544 int cpu_prepare_lwp(struct lwp *, struct lwp_params *);
545 void cpu_set_fork_handler (struct lwp *, void (*)(void *, struct trapframe *), void *);
546 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
547 int fork1 (struct lwp *, int, struct proc **);
548 void start_forked_proc (struct lwp *, struct proc *);
549 int trace_req (struct proc *);
550 void cpu_thread_wait (struct thread *);
551 void setsugid (void);
552 void faultin (struct proc *p);
553 void swapin_request (void);
554 void phold (struct proc *);
555 void prele (struct proc *);
556 void pstall (struct proc *, const char *, int);
558 u_int32_t procrunnable (void);
562 #endif /* _KERNEL || _KERNEL_STRUCTURES */
563 #endif /* !_SYS_PROC_H_ */