Convert almost all of the remaining manual traversals of the allproc
[dragonfly.git] / sys / sys / proc.h
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.
9  *
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.
25  *
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.
37  *
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.79 2006/05/25 07:36:36 dillon Exp $
41  */
42
43 #ifndef _SYS_PROC_H_
44 #define _SYS_PROC_H_
45
46 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
47
48 #error "Userland must include sys/user.h instead of sys/proc.h"
49
50 #else
51
52 #include <sys/callout.h>                /* For struct callout_handle. */
53 #include <sys/filedesc.h>
54 #include <sys/queue.h>
55 #include <sys/rtprio.h>                 /* For struct rtprio. */
56 #include <sys/signal.h>
57 #ifndef _KERNEL
58 #include <sys/time.h>                   /* For structs itimerval, timeval. */
59 #endif
60 #include <sys/ucred.h>
61 #include <sys/event.h>                  /* For struct klist */
62 #include <sys/thread.h>
63 #include <sys/varsym.h>
64 #include <sys/upcall.h>
65 #include <sys/resourcevar.h>
66 #ifdef _KERNEL
67 #include <sys/globaldata.h>
68 #endif
69 #include <sys/systimer.h>
70 #include <sys/usched.h>
71 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
72
73 /*
74  * One structure allocated per session.
75  */
76 struct  session {
77         int     s_count;                /* Ref cnt; pgrps in session. */
78         struct  proc *s_leader;         /* Session leader. */
79         struct  vnode *s_ttyvp;         /* Vnode of controlling terminal. */
80         struct  tty *s_ttyp;            /* Controlling terminal. */
81         pid_t   s_sid;                  /* Session ID */
82         char    s_login[roundup(MAXLOGNAME, sizeof(long))];     /* Setlogin() name. */
83 };
84
85 /*
86  * One structure allocated per process group.
87  */
88 struct  pgrp {
89         LIST_ENTRY(pgrp) pg_hash;       /* Hash chain. */
90         LIST_HEAD(, proc) pg_members;   /* Pointer to pgrp members. */
91         struct  session *pg_session;    /* Pointer to session. */
92         struct  sigiolst pg_sigiolst;   /* List of sigio sources. */
93         pid_t   pg_id;                  /* Pgrp id. */
94         int     pg_jobc;        /* # procs qualifying pgrp for job control */
95 };
96
97 struct  procsig {
98         sigset_t ps_sigignore;  /* Signals being ignored. */
99         sigset_t ps_sigcatch;   /* Signals being caught by user. */
100         int      ps_flag;
101         struct   sigacts *ps_sigacts;
102         int      ps_refcnt;
103 };
104
105 #define PS_NOCLDWAIT    0x0001  /* No zombies if child dies */
106 #define PS_NOCLDSTOP    0x0002  /* No SIGCHLD when children stop. */
107
108 /*
109  * pargs, used to hold a copy of the command line, if it had a sane
110  * length
111  */
112 struct  pargs {
113         u_int   ar_ref;         /* Reference count */
114         u_int   ar_length;      /* Length */
115         u_char  ar_args[0];     /* Arguments */
116 };
117
118 /*
119  * Description of a process.
120  *
121  * This structure contains the information needed to manage a thread of
122  * control, known in UN*X as a process; it has references to substructures
123  * containing descriptions of things that the process uses, but may share
124  * with related processes.  The process structure and the substructures
125  * are always addressable except for those marked "(PROC ONLY)" below,
126  * which might be addressable only on a processor on which the process
127  * is running.
128  *
129  * NOTE!  The process start time is stored in the thread structure associated
130  * with the process.  If the process is a Zombie, then this field will be
131  * inaccessible due to the thread structure being free'd in kern_wait1().
132  */
133
134 struct jail;
135 struct ktrace_node;
136
137 struct lwp {
138         TAILQ_ENTRY(lwp) lwp_procq;     /* run/sleep queue. */
139         LIST_ENTRY(lwp) lwp_list;       /* List of all threads in the proc. */
140
141         struct proc     *lwp_proc;      /* Link to our proc. */
142
143         int             lwp_tid;        /* Our thread id . */
144
145         struct pstats   *lwp_stats;     /* Accounting/statistics (PROC ONLY). */
146 #ifdef notyet
147         int             lwp_flag;       /* P_* flags. */
148         char            lwp_stat;       /* S* process status. */
149 #endif
150
151 #define lwp_startzero   lwp_dupfd
152         int             lwp_dupfd;      /* Sideways return value from fdopen. XXX */
153
154         /*
155          * Scheduling.
156          */
157         sysclock_t      lwp_cpticks;    /* cpu used in sched clock ticks */
158         sysclock_t      lwp_cpbase;     /* Measurement base */
159         fixpt_t         lwp_pctcpu;     /* %cpu for this process */
160         u_int           lwp_swtime;     /* Time swapped in or out. */
161         u_int           lwp_slptime;    /* Time since last blocked. */
162
163         int             lwp_traceflag;  /* Kernel trace points. */
164
165         union usched_data lwp_usdata;   /* User scheduler specific */
166 #define lwp_endzero     lwp_startcopy
167
168 #define lwp_startcopy   lwp_siglist
169         sigset_t        lwp_siglist;    /* Signals arrived but not delivered. */
170         sigset_t        lwp_oldsigmask; /* saved mask from before sigpause */
171         sigset_t        lwp_sigmask;    /* Current signal mask. */
172         stack_t         lwp_sigstk;     /* sp & on stack state variable */
173
174         struct rtprio   lwp_rtprio;     /* Realtime priority. */
175 #define lwp_endcopy     lwp_md
176
177 #ifdef notyet
178         struct user     *lwp_addr;      /* XXX Really struct user? */
179 #endif
180         struct mdproc   lwp_md;         /* Any machine-dependent fields. */
181
182         struct thread   *lwp_thread;    /* backpointer to proc's thread */
183         struct upcall   *lwp_upcall;    /* REGISTERED USERLAND POINTER! */
184         TAILQ_HEAD(, sysmsg) lwp_sysmsgq; /* Recorded asynch system calls */
185         int              lwp_nsysmsg;   /* Number of asynch messages running */
186 };
187
188 struct  proc {
189         LIST_ENTRY(proc) p_list;        /* List of all processes. */
190
191         /* substructures: */
192         struct ucred    *p_ucred;       /* Process owner's identity. */
193         struct filedesc *p_fd;          /* Ptr to open files structure. */
194         struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */
195 #define p_stats p_lwp.lwp_stats
196         struct plimit   *p_limit;       /* Process limits. */
197         void            *p_pad0;
198         struct  procsig *p_procsig;
199 #define p_sigacts       p_procsig->ps_sigacts
200 #define p_sigignore     p_procsig->ps_sigignore
201 #define p_sigcatch      p_procsig->ps_sigcatch
202 #define p_rlimit        p_limit->pl_rlimit
203
204         int             p_flag;         /* P_* flags. */
205         char            p_stat;         /* S* process status. */
206         char            p_pad1[3];
207
208         pid_t           p_pid;          /* Process identifier. */
209         LIST_ENTRY(proc) p_hash;        /* Hash chain. */
210         LIST_ENTRY(proc) p_pglist;      /* List of processes in pgrp. */
211         struct proc     *p_pptr;        /* Pointer to parent process. */
212         LIST_ENTRY(proc) p_sibling;     /* List of sibling processes. */
213         LIST_HEAD(, proc) p_children;   /* Pointer to list of children. */
214         struct callout  p_ithandle;     /* for scheduling p_realtimer */
215         struct varsymset p_varsymset;
216
217 /* The following fields are all zeroed upon creation in fork. */
218 #define p_startzero     p_oppid
219
220         pid_t           p_oppid;        /* Save parent pid during ptrace. XXX */
221
222         struct vmspace  *p_vmspace;     /* Address space. */
223
224 #define p_cpticks p_lwp.lwp_cpticks
225 #define p_cpbase p_lwp.lwp_cpbase
226 #define p_pctcpu p_lwp.lwp_pctcpu
227 #define p_swtime p_lwp.lwp_swtime
228 #define p_slptime p_lwp.lwp_slptime
229
230         struct itimerval p_realtimer;   /* Alarm timer. */
231         struct itimerval p_timer[3];    /* Virtual-time timers. */
232
233         int             p_traceflag;    /* Kernel trace points. */
234         struct ktrace_node *p_tracenode; /* Trace to vnode. */
235
236         sigset_t        p_siglist;      /* Signals arrived but not delivered. */
237
238         struct vnode    *p_textvp;      /* Vnode of executable. */
239
240 #define p_usdata p_lwp.lwp_usdata
241         
242         unsigned int    p_stops;        /* procfs event bitmask */
243         unsigned int    p_stype;        /* procfs stop event type */
244         char            p_step;         /* procfs stop *once* flag */
245         unsigned char   p_pfsflags;     /* procfs flags */
246         char            p_pad2[2];      /* padding for alignment */
247         struct          sigiolst p_sigiolst;    /* list of sigio sources */
248         int             p_sigparent;    /* signal to parent on exit */
249 #define p_oldsigmask p_lwp.lwp_oldsigmask
250         int             p_sig;          /* for core dump/debugger XXX */
251         u_long          p_code;         /* for core dump/debugger XXX */
252         struct klist    p_klist;        /* knotes attached to this process */
253
254         struct timeval  p_start;        /* start time for a process */
255
256 /* End area that is zeroed on creation. */
257 #define p_endzero       p_startcopy
258
259 /* The following fields are all copied upon creation in fork. */
260 #define p_startcopy     p_comm
261
262 #define p_sigmask p_lwp.lwp_sigmask
263 #define p_sigstk p_lwp.lwp_sigstk
264
265         char            p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
266         char            p_lock;         /* Process lock (prevent swap) count. */
267         char            p_nice;         /* Process "nice" value. */
268         char            p_pad3;
269
270         struct pgrp     *p_pgrp;        /* Pointer to process group. */
271
272         struct sysentvec *p_sysent;     /* System call dispatch information. */
273
274         struct uprof    p_prof;         /* Profiling arguments. */
275         struct rtprio   p_rtprio;       /* Realtime priority. */
276         struct pargs    *p_args;
277 /* End area that is copied on creation. */
278 #define p_endcopy       p_addr
279         struct user     *p_addr;        /* Kernel virtual addr of u-area (PROC ONLY) XXX lwp */
280 #define p_md p_lwp.lwp_md
281
282         u_short         p_xstat;        /* Exit status or last stop signal */
283         u_short         p_acflag;       /* Accounting flags. */
284         struct          rusage *p_ru;   /* Exit information. XXX */
285
286         int             p_nthreads;     /* Number of threads in this process. */
287         int             p_nstopped;     /* Number of stopped threads. */
288         int             p_lasttid;      /* Last tid used. */
289         LIST_HEAD(, lwp) p_lwps;        /* List of threads in this process. */
290         void            *p_aioinfo;     /* ASYNC I/O info */
291         int             p_wakeup;       /* thread id XXX lwp */
292         struct proc     *p_peers;       /* XXX lwp */
293         struct proc     *p_leader;      /* XXX lwp */
294         void            *p_emuldata;    /* process-specific emulator state */
295 #define p_thread p_lwp.lwp_thread
296         struct usched   *p_usched;      /* Userland scheduling control */
297         int             p_numposixlocks; /* number of POSIX locks */
298
299         struct lwp      p_lwp;          /* Embedded lwp XXX */
300         struct spinlock p_spin;         /* Spinlock for LWP access to proc */
301 };
302
303 #if defined(_KERNEL)
304 #define p_wchan         p_thread->td_wchan
305 #define p_wmesg         p_thread->td_wmesg
306 #define p_session       p_pgrp->pg_session
307 #define p_pgid          p_pgrp->pg_id
308 #endif
309
310 /*
311  * Status values.   Please note that p_stat doesn't actually take on
312  * synthesized states.
313  */
314 #define SIDL    1               /* Process being created by fork. */
315 #define SRUN    2               /* Currently runnable. */
316 #define SSLEEP  3               /* Sleeping on an address. */
317 #define SSTOP   4               /* Synthesized from SSLEEP + P_STOPPED */
318 #define SZOMB   5               /* Synthesized from P_ZOMBIE for eproc only */
319 #define STHREAD 6               /* Synthesized for eproc only */
320
321 /* These flags are kept in p_flags. */
322 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
323 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
324 #define P_SWAPPEDOUT    0x00004 /* Swapped out of memory */
325 #define P_BREAKTSLEEP   0x00008 /* Event pending, break tsleep on sigcont */
326 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
327 #define P_PROFIL        0x00020 /* Has started profiling. */
328 #define P_SELECT        0x00040 /* Selecting; wakeup/waiting danger. */
329 #define P_SINTR         0x00080 /* Sleep is interruptible. */
330 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
331 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
332 #define P_STOPPED       0x00400 /* SIGSTOP status */
333 #define P_TRACED        0x00800 /* Debugged process being traced. */
334 #define P_WAITED        0x01000 /* SIGSTOP status was returned by wait3/4 */
335 #define P_WEXIT         0x02000 /* Working on exiting. */
336 #define P_EXEC          0x04000 /* Process called exec. */
337
338 /* Should probably be changed into a hold count. */
339 /* was  P_NOSWAP        0x08000 was: Do not swap upages; p->p_hold */
340 /* was  P_PHYSIO        0x10000 was: Doing physical I/O; use p->p_hold */
341
342 #define P_UPCALLPEND    0x20000 /* an upcall is pending */
343
344 #define P_SWAPWAIT      0x40000 /* Waiting for a swapin */
345 #define P_ZOMBIE        0x80000 /* Now in a zombied state */
346
347 /* Marked a kernel thread */
348 #define P_ONRUNQ        0x100000 /* on a user scheduling run queue */
349 #define P_KTHREADP      0x200000 /* Process is really a kernel thread */
350 #define P_IDLESWAP      0x400000 /* Swapout was due to idleswap, not load */
351 #define P_DEADLKTREAT   0x800000 /* lock aquisition - deadlock treatment */
352
353 #define P_JAILED        0x1000000 /* Process is in jail */
354 #define P_OLDMASK       0x2000000 /* need to restore mask before pause */
355 #define P_ALTSTACK      0x4000000 /* have alternate signal stack */
356 #define P_INEXEC        0x8000000 /* Process is in execve(). */
357 #define P_PASSIVE_ACQ   0x10000000 /* Passive acquire cpu (see kern_switch) */
358 #define P_UPCALLWAIT    0x20000000 /* Wait for upcall or signal */
359 #define P_XCPU          0x40000000 /* SIGXCPU */
360
361 #ifdef _KERNEL
362
363 #ifdef MALLOC_DECLARE
364 MALLOC_DECLARE(M_SESSION);
365 MALLOC_DECLARE(M_SUBPROC);
366 MALLOC_DECLARE(M_ZOMBIE);
367 MALLOC_DECLARE(M_PARGS);
368 #endif
369
370 /* flags for suser_xxx() */
371 #define PRISON_ROOT     0x1
372 #define NULL_CRED_OKAY  0x2
373
374 /* Handy macro to determine if p1 can mangle p2 */
375
376 #define PRISON_CHECK(cr1, cr2) \
377         ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
378
379 /*
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".
382  */
383 #define PID_MAX         99999
384 #define NO_PID          100000
385
386 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
387
388 /*
389  * STOPEVENT
390  */
391 extern void stopevent(struct proc*, unsigned int, unsigned int);
392 #define STOPEVENT(p,e,v)                        \
393         do {                                    \
394                 if ((p)->p_stops & (e)) {       \
395                         stopevent(p,e,v);       \
396                 }                               \
397         } while (0)
398
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)
402
403 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
404 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
405 extern u_long pidhash;
406
407 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
408 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
409 extern u_long pgrphash;
410
411 #if 0 
412 #ifndef SET_CURPROC
413 #define SET_CURPROC(p)  (curproc = (p))
414 #endif
415 #endif
416
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 */
423
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;
429
430 /*
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.
434  */
435 #define ESTCPUFREQ      50
436
437 extern  u_long ps_arg_cache_limit;
438 extern  int ps_argsopen;
439 extern  int ps_showallprocs;
440
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. */
444
445 struct vm_zone;
446 struct globaldata;
447 extern struct vm_zone *proc_zone;
448
449 int     enterpgrp (struct proc *p, pid_t pgid, int mksess);
450 void    proc_add_allproc(struct proc *p);
451 void    proc_move_allproc_zombie(struct proc *);
452 void    proc_remove_zombie(struct proc *);
453 void    allproc_scan(int (*callback)(struct proc *, void *), void *data);
454 void    zombproc_scan(int (*callback)(struct proc *, void *), void *data);
455 void    fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
456 void    updatepcpu(struct lwp *, int, int);
457 int     inferior (struct proc *p);
458 int     leavepgrp (struct proc *p);
459 void    sess_hold(struct session *sp);
460 void    sess_rele(struct session *sp);
461 void    mi_switch (struct proc *p);
462 void    procinit (void);
463 void    relscurproc(struct proc *curp);
464 int     p_trespass (struct ucred *cr1, struct ucred *cr2);
465 void    setrunnable (struct proc *);
466 void    clrrunnable (struct proc *);
467 void    sleep_gdinit (struct globaldata *);
468 int     suser (struct thread *td);
469 int     suser_proc (struct proc *p);
470 int     suser_cred (struct ucred *cred, int flag);
471 void    cpu_heavy_switch (struct thread *);
472 void    cpu_lwkt_switch (struct thread *);
473
474 void    cpu_proc_exit (void) __dead2;
475 void    cpu_thread_exit (void) __dead2;
476 void    exit1 (int) __dead2;
477 void    cpu_fork (struct proc *, struct proc *, int);
478 void    cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
479 void    cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
480 int     fork1 (struct lwp *, int, struct proc **);
481 void    start_forked_proc (struct lwp *, struct proc *);
482 int     trace_req (struct proc *);
483 void    cpu_proc_wait (struct proc *);
484 void    cpu_thread_wait (struct thread *);
485 int     cpu_coredump (struct thread *, struct vnode *, struct ucred *);
486 void    setsugid (void);
487 void    faultin (struct proc *p);
488 void    swapin_request (void);
489
490 u_int32_t       procrunnable (void);
491
492 #endif  /* _KERNEL */
493
494 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
495 #endif  /* !_SYS_PROC_H_ */