Fix some warnings and raise WARNS to 6.
[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.107 2007/04/29 18:25:33 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 #include <sys/lock.h>
58 #ifndef _KERNEL
59 #include <sys/time.h>                   /* For structs itimerval, timeval. */
60 #endif
61 #include <sys/ucred.h>
62 #include <sys/event.h>                  /* For struct klist */
63 #include <sys/thread.h>
64 #include <sys/varsym.h>
65 #include <sys/upcall.h>
66 #include <sys/resourcevar.h>
67 #ifdef _KERNEL
68 #include <sys/globaldata.h>
69 #endif
70 #include <sys/systimer.h>
71 #include <sys/usched.h>
72 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
73 #include <sys/signalvar.h>
74
75 LIST_HEAD(proclist, proc);
76 LIST_HEAD(lwplist, lwp);
77
78 /*
79  * One structure allocated per session.
80  */
81 struct  session {
82         int     s_count;                /* Ref cnt; pgrps in session. */
83         struct  proc *s_leader;         /* Session leader. */
84         struct  vnode *s_ttyvp;         /* Vnode of controlling terminal. */
85         struct  tty *s_ttyp;            /* Controlling terminal. */
86         pid_t   s_sid;                  /* Session ID */
87         char    s_login[roundup(MAXLOGNAME, sizeof(long))];     /* Setlogin() name. */
88 };
89
90 /*
91  * One structure allocated per process group.
92  */
93 struct  pgrp {
94         LIST_ENTRY(pgrp) pg_hash;       /* Hash chain. */
95         struct proclist pg_members;     /* Pointer to pgrp members. */
96         struct  session *pg_session;    /* Pointer to session. */
97         struct  sigiolst pg_sigiolst;   /* List of sigio sources. */
98         pid_t   pg_id;                  /* Pgrp id. */
99         int     pg_jobc;        /* # procs qualifying pgrp for job control */
100         struct lock pg_lock;            /* Lock during fork */
101 };
102
103 #define PS_NOCLDWAIT    0x0001  /* No zombies if child dies */
104 #define PS_NOCLDSTOP    0x0002  /* No SIGCHLD when children stop. */
105
106 /*
107  * pargs, used to hold a copy of the command line, if it had a sane
108  * length
109  */
110 struct  pargs {
111         u_int   ar_ref;         /* Reference count */
112         u_int   ar_length;      /* Length */
113         u_char  ar_args[0];     /* Arguments */
114 };
115
116 /*
117  * Description of a process.
118  *
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
125  * is running.
126  *
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().
130  */
131
132 struct jail;
133 struct vkernel;
134 struct ktrace_node;
135
136 enum lwpstat {
137         LSRUN = 1,
138         LSSTOP = 2,
139         LSSLEEP = 3,
140 };
141
142 enum procstat {
143         SIDL = 1,
144         SACTIVE = 2,
145         SSTOP = 3,
146         SZOMB = 4,
147 };
148
149 struct lwp {
150         TAILQ_ENTRY(lwp) lwp_procq;     /* run/sleep queue. */
151         LIST_ENTRY(lwp) lwp_list;       /* List of all threads in the proc. */
152
153         struct proc     *lwp_proc;      /* Link to our proc. */
154
155         lwpid_t         lwp_tid;        /* Our thread id . */
156
157         int             lwp_flag;       /* LWP_* flags. */
158         enum lwpstat    lwp_stat;       /* LS* lwp status. */
159         int             lwp_lock;       /* lwp lock (prevent destruct) count */
160
161         int             lwp_dupfd;      /* Sideways return value from fdopen. XXX */
162
163         /*
164          * The following two fields are marked XXX since (at least) the
165          * 4.4BSD-Lite2 import.  I can only guess the reason:  It is ugly.
166          * These fields are used to pass the trap code from trapsignal() to
167          * postsig(), which gets called later from userret().
168          *
169          * The correct "fix" for these XXX is to convert our signal system
170          * to use signal queues, where each signal can carry its own meta
171          * data.
172          */
173         int             lwp_sig;        /* for core dump/debugger XXX */
174         u_long          lwp_code;       /* for core dump/debugger XXX */
175
176         /*
177          * Scheduling.
178          */
179         sysclock_t      lwp_cpticks;    /* cpu used in sched clock ticks */
180         sysclock_t      lwp_cpbase;     /* Measurement base */
181         fixpt_t         lwp_pctcpu;     /* %cpu for this process */
182         u_int           lwp_slptime;    /* Time since last blocked. */
183
184         int             lwp_traceflag;  /* Kernel trace points. */
185
186         struct rusage   lwp_ru;         /* stats for this lwp */
187
188         union usched_data lwp_usdata;   /* User scheduler specific */
189
190 #define lwp_startcopy   lwp_cpumask
191         cpumask_t       lwp_cpumask;
192         sigset_t        lwp_siglist;    /* Signals arrived but not delivered. */
193         sigset_t        lwp_oldsigmask; /* saved mask from before sigpause */
194         sigset_t        lwp_sigmask;    /* Current signal mask. */
195         stack_t         lwp_sigstk;     /* sp & on stack state variable */
196
197         struct rtprio   lwp_rtprio;     /* Realtime priority. */
198 #define lwp_endcopy     lwp_md
199
200         struct mdproc   lwp_md;         /* Any machine-dependent fields. */
201
202         struct thread   *lwp_thread;    /* backpointer to proc's thread */
203         struct upcall   *lwp_upcall;    /* REGISTERED USERLAND POINTER! */
204 };
205
206 struct  proc {
207         LIST_ENTRY(proc) p_list;        /* List of all processes. */
208
209         /* substructures: */
210         struct ucred    *p_ucred;       /* Process owner's identity. */
211         struct filedesc *p_fd;          /* Ptr to open files structure. */
212         struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */
213         struct plimit   *p_limit;       /* Process limits. */
214         struct pstats   *p_stats;
215         void            *p_pad0;
216         struct sigacts  *p_sigacts;
217 #define p_sigignore     p_sigacts->ps_sigignore
218 #define p_sigcatch      p_sigacts->ps_sigcatch
219 #define p_rlimit        p_limit->pl_rlimit
220
221         int             p_flag;         /* P_* flags. */
222         enum procstat   p_stat;         /* S* process status. */
223         char            p_pad1[3];
224
225         pid_t           p_pid;          /* Process identifier. */
226         LIST_ENTRY(proc) p_hash;        /* Hash chain. */
227         LIST_ENTRY(proc) p_pglist;      /* List of processes in pgrp. */
228         struct proc     *p_pptr;        /* Pointer to parent process. */
229         LIST_ENTRY(proc) p_sibling;     /* List of sibling processes. */
230         struct proclist p_children;     /* Pointer to list of children. */
231         struct callout  p_ithandle;     /* for scheduling p_realtimer */
232         struct varsymset p_varsymset;
233
234         pid_t           p_oppid;        /* Save parent pid during ptrace. XXX */
235
236         struct vmspace  *p_vmspace;     /* Current address space. */
237
238         unsigned int    p_swtime;       /* Time swapped in or out */
239
240         struct itimerval p_realtimer;   /* Alarm timer. */
241         struct itimerval p_timer[3];    /* Virtual-time timers. */
242
243         int             p_traceflag;    /* Kernel trace points. */
244         struct ktrace_node *p_tracenode; /* Trace to vnode. */
245
246         sigset_t        p_siglist;      /* Signals arrived but not delivered. */
247
248         struct vnode    *p_textvp;      /* Vnode of executable. */
249
250         unsigned int    p_stops;        /* procfs event bitmask */
251         unsigned int    p_stype;        /* procfs stop event type */
252         char            p_step;         /* procfs stop *once* flag */
253         unsigned char   p_pfsflags;     /* procfs flags */
254         char            p_pad2[2];      /* padding for alignment */
255         struct          sigiolst p_sigiolst;    /* list of sigio sources */
256         int             p_sigparent;    /* signal to parent on exit */
257         struct klist    p_klist;        /* knotes attached to this process */
258
259         struct timeval  p_start;        /* start time for a process */
260
261         struct rusage   p_ru;           /* stats for this proc */
262         struct rusage   p_cru;          /* sum of stats for reaped children */
263
264 /* The following fields are all copied upon creation in fork. */
265 #define p_startcopy     p_comm
266
267         char            p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
268         char            p_lock;         /* Process lock (prevent destruct) count. */
269         char            p_nice;         /* Process "nice" value. */
270         char            p_pad3;
271
272         struct pgrp     *p_pgrp;        /* Pointer to process group. */
273
274         struct sysentvec *p_sysent;     /* System call dispatch information. */
275
276         struct uprof    p_prof;         /* Profiling arguments. */
277         struct rtprio   p_rtprio;       /* Realtime priority. */
278         struct pargs    *p_args;
279 /* End area that is copied on creation. */
280 #define p_endcopy       p_xstat
281
282         u_short         p_xstat;        /* Exit status or last stop signal */
283         u_short         p_acflag;       /* Accounting flags. */
284
285         int             p_nthreads;     /* Number of threads in this process. */
286         int             p_nstopped;     /* Number of stopped threads. */
287         int             p_lasttid;      /* Last tid used. */
288         struct lwplist  p_lwps; /* List of threads in this process. */
289         void            *p_aioinfo;     /* ASYNC I/O info */
290         int             p_wakeup;       /* thread id XXX lwp */
291         struct proc     *p_peers;       /* XXX lwp */
292         struct proc     *p_leader;      /* XXX lwp */
293         void            *p_emuldata;    /* process-specific emulator state */
294         struct usched   *p_usched;      /* Userland scheduling control */
295         struct vkernel  *p_vkernel;     /* Virtual kernel extension */
296         int             p_numposixlocks; /* number of POSIX locks */
297
298         struct spinlock p_spin;         /* Spinlock for LWP access to proc */
299 };
300
301 #define lwp_wchan       lwp_thread->td_wchan
302 #define lwp_wmesg       lwp_thread->td_wmesg
303 #define p_session       p_pgrp->pg_session
304 #define p_pgid          p_pgrp->pg_id
305
306 /* These flags are kept in p_flags. */
307 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
308 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
309 #define P_SWAPPEDOUT    0x00004 /* Swapped out of memory */
310 #define P_UNUSED3       0x00008 /* was: Event pending, break tsleep on sigcont */
311 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
312 #define P_PROFIL        0x00020 /* Has started profiling. */
313 #define P_UNUSED5       0x00040 /* was: Selecting; wakeup/waiting danger. */
314 #define P_UNUSED4       0x00080 /* was: Sleep is interruptible. */
315 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
316 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
317 #define P_UNUSED2       0x00400 /* was: SIGSTOP status */
318 #define P_TRACED        0x00800 /* Debugged process being traced. */
319 #define P_WAITED        0x01000 /* SIGSTOP status was returned by wait3/4 */
320 #define P_WEXIT         0x02000 /* Working on exiting (master exit) */
321 #define P_EXEC          0x04000 /* Process called exec. */
322
323 /* Should probably be changed into a hold count. */
324 /* was  P_NOSWAP        0x08000 was: Do not swap upages; p->p_hold */
325 #define P_MAILBOX       0x10000 /* Possible mailbox signal pending */
326
327 #define P_UPCALLPEND    0x20000 /* an upcall is pending */
328
329 #define P_SWAPWAIT      0x40000 /* Waiting for a swapin */
330 #define P_UNUSED6       0x80000 /* was: Now in a zombied state */
331
332 /* Marked a kernel thread */
333 #define P_UNUSED07      0x100000 /* was: on a user scheduling run queue */
334 #define P_KTHREADP      0x200000 /* Process is really a kernel thread */
335 #define P_IDLESWAP      0x400000 /* Swapout was due to idleswap, not load */
336 #define P_DEADLKTREAT   0x800000 /* lock aquisition - deadlock treatment */
337
338 #define P_JAILED        0x1000000 /* Process is in jail */
339 #define P_UNUSED0       0x2000000 /* need to restore mask before pause */
340 #define P_UNUSED1       0x4000000 /* have alternate signal stack */
341 #define P_INEXEC        0x8000000 /* Process is in execve(). */
342 #define P_PASSIVE_ACQ   0x10000000 /* Passive acquire cpu (see kern_switch) */
343 #define P_UPCALLWAIT    0x20000000 /* Wait for upcall or signal */
344 #define P_XCPU          0x40000000 /* SIGXCPU */
345
346 #define LWP_ALTSTACK    0x0000001 /* have alternate signal stack */
347 #define LWP_OLDMASK     0x0000002 /* need to restore mask before pause */
348 #define LWP_BREAKTSLEEP 0x0000004 /* Event pending, break tsleep on sigcont */
349 #define LWP_SINTR       0x0000008 /* Sleep is interruptible. */
350 #define LWP_SELECT      0x0000010 /* Selecting; wakeup/waiting danger. */
351 #define LWP_ONRUNQ      0x0000020 /* on a user scheduling run queue */
352 #define LWP_WEXIT       0x0000040 /* working on exiting */
353 #define LWP_WSTOP       0x0000080 /* working on stopping */
354
355 #define FIRST_LWP_IN_PROC(p)            LIST_FIRST(&(p)->p_lwps)
356 #define FOREACH_LWP_IN_PROC(lp, p)      \
357         LIST_FOREACH((lp), &(p)->p_lwps, lwp_list)
358 #define ONLY_LWP_IN_PROC(p)             \
359         (p->p_nthreads != 1 &&          \
360         (panic("%s: proc %p (pid %d cmd %s) has more than one thread",  \
361                __func__, p, p->p_pid, p->p_comm), 1),   \
362         FIRST_LWP_IN_PROC(p))
363
364 /*
365  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
366  * as it is used to represent "no process group".
367  */
368 #define PID_MAX         99999
369 #define NO_PID          100000
370
371 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
372
373 #ifdef _KERNEL
374
375 #ifdef MALLOC_DECLARE
376 MALLOC_DECLARE(M_SESSION);
377 MALLOC_DECLARE(M_SUBPROC);
378 MALLOC_DECLARE(M_PARGS);
379 #endif
380
381 /* flags for suser_xxx() */
382 #define PRISON_ROOT     0x1
383 #define NULL_CRED_OKAY  0x2
384
385 /* Handy macro to determine if p1 can mangle p2 */
386
387 #define PRISON_CHECK(cr1, cr2) \
388         ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
389
390 /*
391  * STOPEVENT
392  */
393 extern void stopevent(struct proc*, unsigned int, unsigned int);
394 #define STOPEVENT(p,e,v)                        \
395         do {                                    \
396                 if ((p)->p_stops & (e)) {       \
397                         stopevent(p,e,v);       \
398                 }                               \
399         } while (0)
400
401 /* hold process in memory, don't destruct , normally for ptrace/procfs work */
402 #define PHOLD(p)        (++(p)->p_lock)
403 #define PRELE(p)        (--(p)->p_lock)
404
405 /* hold lwp in memory, don't destruct , normally for ptrace/procfs work */
406 #define LWPHOLD(lp)     (++(lp)->lwp_lock)
407 #define LWPRELE(lp)     (--(lp)->lwp_lock)
408
409 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
410 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
411 extern u_long pidhash;
412
413 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
414 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
415 extern u_long pgrphash;
416
417 #if 0 
418 #ifndef SET_CURPROC
419 #define SET_CURPROC(p)  (curproc = (p))
420 #endif
421 #endif
422
423 extern struct proc proc0;               /* Process slot for swapper. */
424 extern struct lwp lwp0;                 /* LWP slot for swapper. */
425 extern struct thread thread0;           /* Thread slot for swapper. */
426 extern int hogticks;                    /* Limit on kernel cpu hogs. */
427 extern int nprocs, maxproc;             /* Current and max number of procs. */
428 extern int maxprocperuid;               /* Max procs per uid. */
429 extern int sched_quantum;               /* Scheduling quantum in ticks */
430
431 extern struct proclist allproc;         /* List of all processes. */
432 extern struct proclist zombproc;        /* List of zombie processes. */
433 extern struct proc *initproc;           /* Process slot for init */
434 extern struct thread *pagethread, *updatethread;
435
436 /*
437  * Scheduler independant variables.  The primary scheduler polling frequency,
438  * the maximum ESTCPU value, and the weighting factor for nice values.  A
439  * cpu bound program's estcpu will increase to ESTCPUMAX - 1.
440  */
441 #define ESTCPUFREQ      50
442
443 extern  u_long ps_arg_cache_limit;
444 extern  int ps_argsopen;
445 extern  int ps_showallprocs;
446
447 struct proc *pfind (pid_t);     /* Find process by id. */
448 struct pgrp *pgfind (pid_t);    /* Find process group by id. */
449 struct proc *zpfind (pid_t);    /* Find zombie process by id. */
450
451 struct vm_zone;
452 struct globaldata;
453 struct lwp_params;
454 extern struct vm_zone *proc_zone;
455 extern struct vm_zone *lwp_zone;
456
457 int     enterpgrp (struct proc *p, pid_t pgid, int mksess);
458 void    proc_add_allproc(struct proc *p);
459 void    proc_move_allproc_zombie(struct proc *);
460 void    proc_remove_zombie(struct proc *);
461 void    allproc_scan(int (*callback)(struct proc *, void *), void *data);
462 void    alllwp_scan(int (*callback)(struct lwp *, void *), void *data);
463 void    zombproc_scan(int (*callback)(struct proc *, void *), void *data);
464 void    fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
465 void    updatepcpu(struct lwp *, int, int);
466 int     inferior (struct proc *p);
467 int     leavepgrp (struct proc *p);
468 void    sess_hold(struct session *sp);
469 void    sess_rele(struct session *sp);
470 void    mi_switch (struct proc *p);
471 void    procinit (void);
472 void    relscurproc(struct proc *curp);
473 int     p_trespass (struct ucred *cr1, struct ucred *cr2);
474 void    setrunnable (struct lwp *);
475 void    proc_stop (struct proc *);
476 void    proc_unstop (struct proc *);
477 void    sleep_gdinit (struct globaldata *);
478 int     suser (struct thread *td);
479 int     suser_cred (struct ucred *cred, int flag);
480 void    cpu_heavy_switch (struct thread *);
481 void    cpu_lwkt_switch (struct thread *);
482
483 void    cpu_lwp_exit (void) __dead2;
484 void    cpu_thread_exit (void) __dead2;
485 void    lwp_exit (int masterexit) __dead2;
486 void    lwp_dispose (struct lwp *);
487 void    killlwps (struct lwp *);
488 void    exit1 (int) __dead2;
489 void    cpu_fork (struct lwp *, struct lwp *, int);
490 int     cpu_prepare_lwp(struct lwp *, struct lwp_params *);
491 void    cpu_set_fork_handler (struct lwp *, void (*)(void *, struct trapframe *), void *);
492 void    cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
493 int     fork1 (struct lwp *, int, struct proc **);
494 void    start_forked_proc (struct lwp *, struct proc *);
495 int     trace_req (struct proc *);
496 void    cpu_proc_wait (struct proc *);
497 void    cpu_thread_wait (struct thread *);
498 int     cpu_coredump (struct thread *, struct vnode *, struct ucred *);
499 void    setsugid (void);
500 void    faultin (struct proc *p);
501 void    swapin_request (void);
502
503 u_int32_t       procrunnable (void);
504
505 #endif  /* _KERNEL */
506
507 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
508 #endif  /* !_SYS_PROC_H_ */