Merge commit 'crater/master'
[dragonfly.git] / sys / sys / proc.h
blob23fe8a85b58e2902a9e61798f8f2283ace965336
1 /*-
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
12 * are met:
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
36 * SUCH DAMAGE.
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.121 2008/07/23 17:22:33 dillon Exp $
43 #ifndef _SYS_PROC_H_
44 #define _SYS_PROC_H_
46 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
48 #error "Userland must include sys/user.h instead of sys/proc.h"
50 #else
52 #include <sys/callout.h> /* For struct callout_handle. */
53 #include <sys/filedesc.h>
54 #include <sys/queue.h>
55 #include <sys/tree.h>
56 #include <sys/rtprio.h> /* For struct rtprio. */
57 #include <sys/signal.h>
58 #include <sys/lock.h>
59 #ifndef _KERNEL
60 #include <sys/time.h> /* For structs itimerval, timeval. */
61 #endif
62 #include <sys/ucred.h>
63 #include <sys/event.h> /* For struct klist */
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>
69 #ifdef _KERNEL
70 #include <sys/globaldata.h>
71 #endif
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);
82 struct lwp_rb_tree;
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.
89 struct 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.
101 struct pgrp {
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 */
108 struct lock pg_lock; /* Lock during fork */
111 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
112 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
115 * pargs, used to hold a copy of the command line, if it had a sane
116 * length
118 struct pargs {
119 u_int ar_ref; /* Reference count */
120 u_int ar_length; /* Length */
121 u_char ar_args[0]; /* Arguments */
125 * Description of a process.
127 * This structure contains the information needed to manage a thread of
128 * control, known in UN*X as a process; it has references to substructures
129 * containing descriptions of things that the process uses, but may share
130 * with related processes. The process structure and the substructures
131 * are always addressable except for those marked "(PROC ONLY)" below,
132 * which might be addressable only on a processor on which the process
133 * is running.
135 * NOTE! The process start time is stored in the thread structure associated
136 * with the process. If the process is a Zombie, then this field will be
137 * inaccessible due to the thread structure being free'd in kern_wait1().
140 struct jail;
141 struct vkernel_proc;
142 struct vkernel_lwp;
143 struct vmspace_entry;
144 struct ktrace_node;
146 enum lwpstat {
147 LSRUN = 1,
148 LSSTOP = 2,
149 LSSLEEP = 3,
152 enum procstat {
153 SIDL = 1,
154 SACTIVE = 2,
155 SSTOP = 3,
156 SZOMB = 4,
159 struct lwp {
160 TAILQ_ENTRY(lwp) lwp_procq; /* run/sleep queue. */
161 union {
162 RB_ENTRY(lwp) lwp_rbnode; /* RB tree node - lwp in proc */
163 LIST_ENTRY(lwp) lwp_reap_entry; /* reaper list */
164 } u;
166 struct proc *lwp_proc; /* Link to our proc. */
167 struct vmspace *lwp_vmspace; /* Inherited from p_vmspace */
168 struct vkernel_lwp *lwp_vkernel;/* VKernel support, lwp part */
170 lwpid_t lwp_tid; /* Our thread id . */
172 int lwp_flag; /* LWP_* flags. */
173 enum lwpstat lwp_stat; /* LS* lwp status. */
174 int lwp_lock; /* lwp lock (prevent destruct) count */
176 int lwp_dupfd; /* Sideways return value from fdopen. XXX */
179 * The following two fields are marked XXX since (at least) the
180 * 4.4BSD-Lite2 import. I can only guess the reason: It is ugly.
181 * These fields are used to pass the trap code from trapsignal() to
182 * postsig(), which gets called later from userret().
184 * The correct "fix" for these XXX is to convert our signal system
185 * to use signal queues, where each signal can carry its own meta
186 * data.
188 int lwp_sig; /* for core dump/debugger XXX */
189 u_long lwp_code; /* for core dump/debugger XXX */
192 * Scheduling.
194 sysclock_t lwp_cpticks; /* cpu used in sched clock ticks */
195 sysclock_t lwp_cpbase; /* Measurement base */
196 fixpt_t lwp_pctcpu; /* %cpu for this process */
197 u_int lwp_slptime; /* Time since last blocked. */
199 int lwp_traceflag; /* Kernel trace points. */
201 struct rusage lwp_ru; /* stats for this lwp */
203 union usched_data lwp_usdata; /* User scheduler specific */
205 #define lwp_startcopy lwp_cpumask
206 cpumask_t lwp_cpumask;
207 sigset_t lwp_siglist; /* Signals arrived but not delivered. */
208 sigset_t lwp_oldsigmask; /* saved mask from before sigpause */
209 sigset_t lwp_sigmask; /* Current signal mask. */
210 stack_t lwp_sigstk; /* sp & on stack state variable */
212 struct rtprio lwp_rtprio; /* Realtime priority. */
213 #define lwp_endcopy lwp_md
215 struct mdproc lwp_md; /* Any machine-dependent fields. */
217 struct thread *lwp_thread; /* backpointer to proc's thread */
218 struct upcall *lwp_upcall; /* REGISTERED USERLAND POINTER! */
221 struct proc {
222 LIST_ENTRY(proc) p_list; /* List of all processes. */
224 /* substructures: */
225 struct ucred *p_ucred; /* Process owner's identity. */
226 struct filedesc *p_fd; /* Ptr to open files structure. */
227 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */
228 struct plimit *p_limit; /* Process limits. */
229 struct pstats *p_stats;
230 void *p_pad0;
231 struct sigacts *p_sigacts;
232 #define p_sigignore p_sigacts->ps_sigignore
233 #define p_sigcatch p_sigacts->ps_sigcatch
234 #define p_rlimit p_limit->pl_rlimit
236 int p_flag; /* P_* flags. */
237 enum procstat p_stat; /* S* process status. */
238 char p_pad1[3];
240 pid_t p_pid; /* Process identifier. */
241 LIST_ENTRY(proc) p_hash; /* Hash chain. */
242 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
243 struct proc *p_pptr; /* Pointer to parent process. */
244 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
245 struct proclist p_children; /* Pointer to list of children. */
246 struct callout p_ithandle; /* for scheduling p_realtimer */
247 struct varsymset p_varsymset;
248 struct iosched_data p_iosdata; /* Dynamic I/O scheduling data */
250 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
252 struct vmspace *p_vmspace; /* Current address space. */
254 unsigned int p_swtime; /* Time swapped in or out */
256 struct itimerval p_realtimer; /* Alarm timer. */
257 struct itimerval p_timer[3]; /* Virtual-time timers. */
259 int p_traceflag; /* Kernel trace points. */
260 struct ktrace_node *p_tracenode; /* Trace to vnode. */
262 sigset_t p_siglist; /* Signals arrived but not delivered. */
264 struct vnode *p_textvp; /* Vnode of executable. */
266 unsigned int p_stops; /* procfs event bitmask */
267 unsigned int p_stype; /* procfs stop event type */
268 char p_step; /* procfs stop *once* flag */
269 unsigned char p_pfsflags; /* procfs flags */
270 char p_pad2[2]; /* padding for alignment */
271 struct sigiolst p_sigiolst; /* list of sigio sources */
272 int p_sigparent; /* signal to parent on exit */
273 struct klist p_klist; /* knotes attached to this process */
275 struct timeval p_start; /* start time for a process */
277 struct rusage p_ru; /* stats for this proc */
278 struct rusage p_cru; /* sum of stats for reaped children */
280 /* The following fields are all copied upon creation in fork. */
281 #define p_startcopy p_comm
283 char p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
284 char p_lock; /* Process lock (prevent destruct) count. */
285 char p_nice; /* Process "nice" value. */
286 char p_pad3;
288 struct pgrp *p_pgrp; /* Pointer to process group. */
290 struct sysentvec *p_sysent; /* System call dispatch information. */
292 struct uprof p_prof; /* Profiling arguments. */
293 struct rtprio p_rtprio; /* Realtime priority. */
294 struct pargs *p_args;
295 /* End area that is copied on creation. */
296 #define p_endcopy p_xstat
298 u_short p_xstat; /* Exit status or last stop signal */
299 u_short p_acflag; /* Accounting flags. */
301 int p_nthreads; /* Number of threads in this process. */
302 int p_nstopped; /* Number of stopped threads. */
303 int p_lasttid; /* Last tid used. */
304 struct lwp_rb_tree p_lwp_tree; /* RB tree of LWPs for this process */
305 void *p_aioinfo; /* ASYNC I/O info */
306 int p_wakeup; /* thread id XXX lwp */
307 struct proc *p_peers; /* XXX lwp */
308 struct proc *p_leader; /* XXX lwp */
309 void *p_emuldata; /* process-specific emulator state */
310 struct usched *p_usched; /* Userland scheduling control */
311 struct vkernel_proc *p_vkernel; /* VKernel support, proc part */
312 int p_numposixlocks; /* number of POSIX locks */
314 struct spinlock p_spin; /* Spinlock for LWP access to proc */
317 #define lwp_wchan lwp_thread->td_wchan
318 #define lwp_wmesg lwp_thread->td_wmesg
319 #define p_session p_pgrp->pg_session
320 #define p_pgid p_pgrp->pg_id
322 /* These flags are kept in p_flags. */
323 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
324 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
325 #define P_SWAPPEDOUT 0x00004 /* Swapped out of memory */
326 #define P_UNUSED3 0x00008 /* was: Event pending, break tsleep on sigcont */
327 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
328 #define P_PROFIL 0x00020 /* Has started profiling. */
329 #define P_UNUSED5 0x00040 /* was: Selecting; wakeup/waiting danger. */
330 #define P_UNUSED4 0x00080 /* was: Sleep is interruptible. */
331 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
332 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
333 #define P_UNUSED2 0x00400 /* was: SIGSTOP status */
334 #define P_TRACED 0x00800 /* Debugged process being traced. */
335 #define P_WAITED 0x01000 /* SIGSTOP status was returned by wait3/4 */
336 #define P_WEXIT 0x02000 /* Working on exiting (master exit) */
337 #define P_EXEC 0x04000 /* Process called exec. */
338 #define P_CONTINUED 0x08000 /* Proc has continued from a stopped state. */
340 /* Should probably be changed into a hold count. */
341 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
342 #define P_MAILBOX 0x10000 /* Possible mailbox signal pending */
344 #define P_UPCALLPEND 0x20000 /* an upcall is pending */
346 #define P_SWAPWAIT 0x40000 /* Waiting for a swapin */
347 #define P_UNUSED6 0x80000 /* was: Now in a zombied state */
349 /* Marked a kernel thread */
350 #define P_UNUSED07 0x100000 /* was: on a user scheduling run queue */
351 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
352 #define P_IDLESWAP 0x400000 /* Swapout was due to idleswap, not load */
353 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
355 #define P_JAILED 0x1000000 /* Process is in jail */
356 #define P_UNUSED0 0x2000000 /* need to restore mask before pause */
357 #define P_UNUSED1 0x4000000 /* have alternate signal stack */
358 #define P_INEXEC 0x8000000 /* Process is in execve(). */
359 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */
360 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */
361 #define P_XCPU 0x40000000 /* SIGXCPU */
364 * LWP_WSTOP: When set the thread will stop prior to return to userland
365 * and has been counted in the process stop-threads-count, but
366 * may still be running in kernel-land.
368 * LWP_WEXIT: When set the thread has been asked to exit and will not return
369 * to userland. p_nthreads will not be decremented until the
370 * thread has actually exited.
372 #define LWP_ALTSTACK 0x0000001 /* have alternate signal stack */
373 #define LWP_OLDMASK 0x0000002 /* need to restore mask before pause */
374 #define LWP_BREAKTSLEEP 0x0000004 /* Event pending, break tsleep on sigcont */
375 #define LWP_SINTR 0x0000008 /* Sleep is interruptible. */
376 #define LWP_SELECT 0x0000010 /* Selecting; wakeup/waiting danger. */
377 #define LWP_ONRUNQ 0x0000020 /* on a user scheduling run queue */
378 #define LWP_WEXIT 0x0000040 /* working on exiting */
379 #define LWP_WSTOP 0x0000080 /* working on stopping */
381 #define FIRST_LWP_IN_PROC(p) RB_FIRST(lwp_rb_tree, &(p)->p_lwp_tree)
382 #define FOREACH_LWP_IN_PROC(lp, p) \
383 RB_FOREACH(lp, lwp_rb_tree, &(p)->p_lwp_tree)
384 #define ONLY_LWP_IN_PROC(p) \
385 (p->p_nthreads != 1 && \
386 (panic("%s: proc %p (pid %d cmd %s) has more than one thread", \
387 __func__, p, p->p_pid, p->p_comm), 1), \
388 RB_ROOT(&p->p_lwp_tree))
391 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
392 * as it is used to represent "no process group".
394 #define PID_MAX 99999
395 #define NO_PID 100000
397 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
399 #ifdef _KERNEL
401 #ifdef MALLOC_DECLARE
402 MALLOC_DECLARE(M_SESSION);
403 MALLOC_DECLARE(M_PROC);
404 MALLOC_DECLARE(M_LWP);
405 MALLOC_DECLARE(M_SUBPROC);
406 MALLOC_DECLARE(M_PARGS);
407 #endif
409 /* for priv_check_cred() */
410 #define NULL_CRED_OKAY 0x2
412 /* Handy macro to determine if p1 can mangle p2 */
414 #define PRISON_CHECK(cr1, cr2) \
415 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
418 * STOPEVENT
420 extern void stopevent(struct proc*, unsigned int, unsigned int);
421 #define STOPEVENT(p,e,v) \
422 do { \
423 if ((p)->p_stops & (e)) { \
424 stopevent(p,e,v); \
426 } while (0)
428 /* hold process in memory, don't destruct , normally for ptrace/procfs work */
429 #define PHOLD(p) (++(p)->p_lock)
430 #define PRELE(p) (--(p)->p_lock)
432 /* hold lwp in memory, don't destruct , normally for ptrace/procfs work */
433 /* atomic ops because they can occur from an IPI */
434 #define LWPHOLD(lp) atomic_add_int(&(lp)->lwp_lock, 1)
435 #define LWPRELE(lp) atomic_add_int(&(lp)->lwp_lock, -1)
437 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
438 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
439 extern u_long pidhash;
441 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
442 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
443 extern u_long pgrphash;
445 #if 0
446 #ifndef SET_CURPROC
447 #define SET_CURPROC(p) (curproc = (p))
448 #endif
449 #endif
451 extern struct proc proc0; /* Process slot for swapper. */
452 extern struct lwp lwp0; /* LWP slot for swapper. */
453 extern struct thread thread0; /* Thread slot for swapper. */
454 extern int hogticks; /* Limit on kernel cpu hogs. */
455 extern int nprocs, maxproc; /* Current and max number of procs. */
456 extern int maxprocperuid; /* Max procs per uid. */
457 extern int sched_quantum; /* Scheduling quantum in ticks */
459 extern struct proclist allproc; /* List of all processes. */
460 extern struct proclist zombproc; /* List of zombie processes. */
461 extern struct proc *initproc; /* Process slot for init */
462 extern struct thread *pagethread, *updatethread;
465 * Scheduler independant variables. The primary scheduler polling frequency,
466 * the maximum ESTCPU value, and the weighting factor for nice values. A
467 * cpu bound program's estcpu will increase to ESTCPUMAX - 1.
469 #define ESTCPUFREQ 50
471 extern u_long ps_arg_cache_limit;
472 extern int ps_argsopen;
473 extern int ps_showallprocs;
475 struct proc *pfind (pid_t); /* Find process by id. */
476 struct pgrp *pgfind (pid_t); /* Find process group by id. */
477 struct proc *zpfind (pid_t); /* Find zombie process by id. */
479 struct globaldata;
480 struct lwp_params;
482 int enterpgrp (struct proc *p, pid_t pgid, int mksess);
483 void proc_add_allproc(struct proc *p);
484 void proc_move_allproc_zombie(struct proc *);
485 void proc_remove_zombie(struct proc *);
486 void allproc_scan(int (*callback)(struct proc *, void *), void *data);
487 void alllwp_scan(int (*callback)(struct lwp *, void *), void *data);
488 void zombproc_scan(int (*callback)(struct proc *, void *), void *data);
489 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
490 void updatepcpu(struct lwp *, int, int);
491 int inferior (struct proc *p);
492 int leavepgrp (struct proc *p);
493 void sess_hold(struct session *sp);
494 void sess_rele(struct session *sp);
495 void procinit (void);
496 void relscurproc(struct proc *curp);
497 int p_trespass (struct ucred *cr1, struct ucred *cr2);
498 void setrunnable (struct lwp *);
499 void proc_stop (struct proc *);
500 void proc_unstop (struct proc *);
501 void sleep_gdinit (struct globaldata *);
502 int suser (struct thread *td);
503 int suser_cred (struct ucred *cred, int flag);
504 void cpu_heavy_switch (struct thread *);
505 void cpu_lwkt_switch (struct thread *);
507 void cpu_lwp_exit (void) __dead2;
508 void cpu_thread_exit (void) __dead2;
509 void lwp_exit (int masterexit) __dead2;
510 void lwp_dispose (struct lwp *);
511 int killalllwps (int);
512 void exit1 (int) __dead2;
513 void cpu_fork (struct lwp *, struct lwp *, int);
514 int cpu_prepare_lwp(struct lwp *, struct lwp_params *);
515 void cpu_set_fork_handler (struct lwp *, void (*)(void *, struct trapframe *), void *);
516 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
517 int fork1 (struct lwp *, int, struct proc **);
518 void start_forked_proc (struct lwp *, struct proc *);
519 int trace_req (struct proc *);
520 void cpu_proc_wait (struct proc *);
521 void cpu_thread_wait (struct thread *);
522 void setsugid (void);
523 void faultin (struct proc *p);
524 void swapin_request (void);
526 u_int32_t procrunnable (void);
528 #endif /* _KERNEL */
530 #endif /* _KERNEL || _KERNEL_STRUCTURES */
531 #endif /* !_SYS_PROC_H_ */