Do some fairly major include file cleanups to further separate kernelland
[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.37 2003/11/21 22:46:13 dillon Exp $
41  */
42
43 #ifndef _SYS_PROC_H_
44 #define _SYS_PROC_H_
45
46 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
47 #error "Userland must include sys/user.h instead of sys/proc.h"
48 #endif
49
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>
55 #ifndef _KERNEL
56 #include <sys/time.h>                   /* For structs itimerval, timeval. */
57 #endif
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 #ifdef _KERNEL
64 #include <sys/globaldata.h>
65 #endif
66 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
67
68 /*
69  * One structure allocated per session.
70  */
71 struct  session {
72         int     s_count;                /* Ref cnt; pgrps in session. */
73         struct  proc *s_leader;         /* Session leader. */
74         struct  vnode *s_ttyvp;         /* Vnode of controlling terminal. */
75         struct  tty *s_ttyp;            /* Controlling terminal. */
76         pid_t   s_sid;                  /* Session ID */
77         char    s_login[roundup(MAXLOGNAME, sizeof(long))];     /* Setlogin() name. */
78 };
79
80 /*
81  * One structure allocated per process group.
82  */
83 struct  pgrp {
84         LIST_ENTRY(pgrp) pg_hash;       /* Hash chain. */
85         LIST_HEAD(, proc) pg_members;   /* Pointer to pgrp members. */
86         struct  session *pg_session;    /* Pointer to session. */
87         struct  sigiolst pg_sigiolst;   /* List of sigio sources. */
88         pid_t   pg_id;                  /* Pgrp id. */
89         int     pg_jobc;        /* # procs qualifying pgrp for job control */
90 };
91
92 struct  procsig {
93         sigset_t ps_sigignore;  /* Signals being ignored. */
94         sigset_t ps_sigcatch;   /* Signals being caught by user. */
95         int      ps_flag;
96         struct   sigacts *ps_sigacts;
97         int      ps_refcnt;
98 };
99
100 #define PS_NOCLDWAIT    0x0001  /* No zombies if child dies */
101 #define PS_NOCLDSTOP    0x0002  /* No SIGCHLD when children stop. */
102
103 /*
104  * pargs, used to hold a copy of the command line, if it had a sane
105  * length
106  */
107 struct  pargs {
108         u_int   ar_ref;         /* Reference count */
109         u_int   ar_length;      /* Length */
110         u_char  ar_args[0];     /* Arguments */
111 };
112
113 /*
114  * Description of a process.
115  *
116  * This structure contains the information needed to manage a thread of
117  * control, known in UN*X as a process; it has references to substructures
118  * containing descriptions of things that the process uses, but may share
119  * with related processes.  The process structure and the substructures
120  * are always addressable except for those marked "(PROC ONLY)" below,
121  * which might be addressable only on a processor on which the process
122  * is running.
123  */
124
125 struct jail;
126
127 struct  proc {
128         TAILQ_ENTRY(proc) p_procq;      /* run/sleep queue. */
129         LIST_ENTRY(proc) p_list;        /* List of all processes. */
130
131         /* substructures: */
132         struct  ucred *p_ucred;         /* Process owner's identity. */
133         struct  filedesc *p_fd;         /* Ptr to open files structure. */
134         struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */
135         struct  pstats *p_stats;        /* Accounting/statistics (PROC ONLY). */
136         struct  plimit *p_limit;        /* Process limits. */
137 #if 0
138         struct  vm_object *p_upages_obj;/* Upages object */
139 #else
140         void            *p_dummy1;
141 #endif
142         struct  procsig *p_procsig;
143 #define p_sigacts       p_procsig->ps_sigacts
144 #define p_sigignore     p_procsig->ps_sigignore
145 #define p_sigcatch      p_procsig->ps_sigcatch
146 #define p_rlimit        p_limit->pl_rlimit
147
148         int     p_flag;                 /* P_* flags. */
149         char    p_stat;                 /* S* process status. */
150         char    p_pad1[3];
151
152         pid_t   p_pid;                  /* Process identifier. */
153         LIST_ENTRY(proc) p_hash;        /* Hash chain. */
154         LIST_ENTRY(proc) p_pglist;      /* List of processes in pgrp. */
155         struct  proc *p_pptr;           /* Pointer to parent process. */
156         LIST_ENTRY(proc) p_sibling;     /* List of sibling processes. */
157         LIST_HEAD(, proc) p_children;   /* Pointer to list of children. */
158         struct callout_handle p_ithandle; /* for scheduling p_realtimer */
159         struct  varsymset p_varsymset;
160
161 /* The following fields are all zeroed upon creation in fork. */
162 #define p_startzero     p_oppid
163
164         pid_t   p_oppid;         /* Save parent pid during ptrace. XXX */
165         int     p_dupfd;         /* Sideways return value from fdopen. XXX */
166
167         struct  vmspace *p_vmspace;     /* Address space. */
168
169         /* scheduling */
170         u_int   p_estcpu;        /* Time averaged value of p_cpticks. */
171         int     p_cpticks;       /* Ticks of cpu time. */
172         fixpt_t p_pctcpu;        /* %cpu for this process during p_swtime */
173         u_int   p_swtime;        /* Time swapped in or out. */
174         u_int   p_slptime;       /* Time since last blocked. */
175
176         struct  itimerval p_realtimer;  /* Alarm timer. */
177
178         int     p_traceflag;            /* Kernel trace points. */
179         struct  vnode *p_tracep;        /* Trace to vnode. */
180
181         sigset_t p_siglist;             /* Signals arrived but not delivered. */
182
183         struct  vnode *p_textvp;        /* Vnode of executable. */
184
185         char    p_lock;                 /* Process lock (prevent swap) count. */
186         short   p_priority;             /* overall process priority */
187         char    p_rqindex;              /* Run queue index */
188
189         unsigned int    p_stops;        /* procfs event bitmask */
190         unsigned int    p_stype;        /* procfs stop event type */
191         char    p_step;                 /* procfs stop *once* flag */
192         unsigned char   p_pfsflags;     /* procfs flags */
193         char    p_pad3[2];              /* padding for alignment */
194         struct  sigiolst p_sigiolst;    /* list of sigio sources */
195         int     p_sigparent;            /* signal to parent on exit */
196         sigset_t p_oldsigmask;          /* saved mask from before sigpause */
197         int     p_sig;                  /* for core dump/debugger XXX */
198         u_long  p_code;                 /* for core dump/debugger XXX */
199         struct  klist p_klist;          /* knotes attached to this process */
200
201 /* End area that is zeroed on creation. */
202 #define p_endzero       p_startcopy
203
204 /* The following fields are all copied upon creation in fork. */
205 #define p_startcopy     p_sigmask
206
207         sigset_t p_sigmask;     /* Current signal mask. */
208         stack_t p_sigstk;       /* sp & on stack state variable */
209         u_char  p_unused00;     /* (used to be p_priority) */
210         char    p_nice;         /* Process "nice" value. */
211
212         struct  pgrp *p_pgrp;   /* Pointer to process group. */
213
214         struct  sysentvec *p_sysent; /* System call dispatch information. */
215
216         struct  rtprio p_rtprio;        /* Realtime priority. */
217         struct  pargs *p_args;
218 /* End area that is copied on creation. */
219 #define p_endcopy       p_addr
220         struct  user *p_addr;   /* Kernel virtual addr of u-area (PROC ONLY). */
221         struct  mdproc p_md;    /* Any machine-dependent fields. */
222
223         u_short p_xstat;        /* Exit status for wait; also stop signal. */
224         u_short p_acflag;       /* Accounting flags. */
225         struct  rusage *p_ru;   /* Exit information. XXX */
226
227         int     p_nthreads;     /* number of threads (only in leader) */
228         void    *p_aioinfo;     /* ASYNC I/O info */
229         int     p_wakeup;       /* thread id */
230         struct proc *p_peers;   
231         struct proc *p_leader;
232         void    *p_emuldata;    /* process-specific emulator state data */
233         struct thread *p_thread; /* temporarily embed thread struct in proc */
234         struct upcall *p_upcall; /* USERLAND POINTER! registered upcall */
235 };
236
237 #if defined(_KERNEL)
238 #define p_wchan         p_thread->td_wchan
239 #define p_wmesg         p_thread->td_wmesg
240 #define p_comm          p_thread->td_comm
241 #define p_session       p_pgrp->pg_session
242 #define p_pgid          p_pgrp->pg_id
243 #endif
244
245 /* Status values. */
246 #define SIDL    1               /* Process being created by fork. */
247 #define SRUN    2               /* Currently runnable. */
248 #define SSLEEP  3               /* Sleeping on an address. */
249 #define SSTOP   4               /* Process debugging or suspension. */
250 #define SZOMB   5               /* Awaiting collection by parent. */
251 #define STHREAD 6               /* Synthesized for eproc only */
252
253 /* These flags are kept in p_flags. */
254 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
255 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
256 #define P_INMEM         0x00004 /* Loaded into memory. */
257 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
258 #define P_PROFIL        0x00020 /* Has started profiling. */
259 #define P_SELECT        0x00040 /* Selecting; wakeup/waiting danger. */
260 #define P_SINTR         0x00080 /* Sleep is interruptible. */
261 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
262 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
263 #define P_CURPROC       0x00400 /* 'Current process' on this cpu */
264 #define P_TRACED        0x00800 /* Debugged process being traced. */
265 #define P_WAITED        0x01000 /* Debugging process has waited for child. */
266 #define P_WEXIT         0x02000 /* Working on exiting. */
267 #define P_EXEC          0x04000 /* Process called exec. */
268
269 /* Should probably be changed into a hold count. */
270 /* was  P_NOSWAP        0x08000 was: Do not swap upages; p->p_hold */
271 /* was  P_PHYSIO        0x10000 was: Doing physical I/O; use p->p_hold */
272
273 #define P_UPCALLPEND    0x20000 /* an upcall is pending */
274
275 #define P_SWAPPING      0x40000 /* Process is being swapped. */
276 #define P_SWAPINREQ     0x80000 /* Swapin request due to wakeup */
277
278 /* Marked a kernel thread */
279 #define P_ONRUNQ        0x100000 /* on a user scheduling run queue */
280 #define P_KTHREADP      0x200000 /* Process is really a kernel thread */
281 #define P_CP_RELEASED   0x400000 /* directly schedule LWKT, ignore user schd */
282
283 #define P_DEADLKTREAT   0x800000 /* lock aquisition - deadlock treatment */
284
285 #define P_JAILED        0x1000000 /* Process is in jail */
286 #define P_OLDMASK       0x2000000 /* need to restore mask before pause */
287 #define P_ALTSTACK      0x4000000 /* have alternate signal stack */
288 #define P_INEXEC        0x8000000 /* Process is in execve(). */
289 #define P_PASSIVE_ACQ   0x10000000 /* Passive acquire cpu (see kern_switch) */
290
291 #ifdef _KERNEL
292
293 #ifdef MALLOC_DECLARE
294 MALLOC_DECLARE(M_SESSION);
295 MALLOC_DECLARE(M_SUBPROC);
296 MALLOC_DECLARE(M_ZOMBIE);
297 MALLOC_DECLARE(M_PARGS);
298 #endif
299
300 /* flags for suser_xxx() */
301 #define PRISON_ROOT     1
302
303 /* Handy macro to determine if p1 can mangle p2 */
304
305 #define PRISON_CHECK(cr1, cr2) \
306         ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
307
308 /*
309  * Handy macro for LISTs.
310  */
311 #define FOREACH_PROC_IN_SYSTEM(p)       LIST_FOREACH((p), &allproc, p_list)
312
313 /*
314  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
315  * as it is used to represent "no process group".
316  */
317 #define PID_MAX         99999
318 #define NO_PID          100000
319
320 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
321 #define SESSHOLD(s)     ((s)->s_count++)
322 #define SESSRELE(s) {                                                   \
323         if (--(s)->s_count == 0)                                        \
324                 FREE(s, M_SESSION);                                     \
325 }
326
327 /*
328  * STOPEVENT
329  */
330 extern void stopevent(struct proc*, unsigned int, unsigned int);
331 #define STOPEVENT(p,e,v)                        \
332         do {                                    \
333                 if ((p)->p_stops & (e)) {       \
334                         stopevent(p,e,v);       \
335                 }                               \
336         } while (0)
337
338 /* hold process U-area in memory, normally for ptrace/procfs work */
339 #define PHOLD(p) {                                                      \
340         if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
341                 faultin(p);                                             \
342 }
343 #define PRELE(p)        (--(p)->p_lock)
344
345 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
346 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
347 extern u_long pidhash;
348
349 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
350 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
351 extern u_long pgrphash;
352
353 #if 0 
354 #ifndef SET_CURPROC
355 #define SET_CURPROC(p)  (curproc = (p))
356 #endif
357 #endif
358
359 extern struct proc proc0;               /* Process slot for swapper. */
360 extern struct thread thread0;           /* Thread slot for swapper. */
361 extern int hogticks;                    /* Limit on kernel cpu hogs. */
362 extern int nprocs, maxproc;             /* Current and max number of procs. */
363 extern int maxprocperuid;               /* Max procs per uid. */
364 extern int sched_quantum;               /* Scheduling quantum in ticks */
365
366 LIST_HEAD(proclist, proc);
367 extern struct proclist allproc;         /* List of all processes. */
368 extern struct proclist zombproc;        /* List of zombie processes. */
369 extern struct proc *initproc;           /* Process slot for init */
370 extern struct thread *pagethread, *updatethread;
371
372 #define NQS     32                      /* 32 run queues. */
373 TAILQ_HEAD(rq, proc);
374 extern struct rq queues[];
375 extern struct rq rtqueues[];
376 extern struct rq idqueues[];
377 extern int      whichqs;        /* Bit mask summary of non-empty Q's. */
378 extern int      whichrtqs;      /* Bit mask summary of non-empty Q's. */
379 extern int      whichidqs;      /* Bit mask summary of non-empty Q's. */
380
381 /*
382  * Scheduler estcpu macros.
383  *
384  * p_priority = NICE_ADJUST(p->p_nice - PRIO_MIN) +
385  *                      p->p_estcpu / ESTCPURAMP;
386  *
387  * NICE_WEIGHT determines the p_estcpu overlap between nice levels.   It
388  * cannot exceed 3.0.  A value of 2.0 gives us a nice small overlap between
389  * nice -20 and nice +0.  A value of 3.0 reduces the overlap while a value
390  * of 1.0 increases the overlap.
391  *
392  * ESTCPURAMP determines how slowly estcpu effects the process priority.
393  * Higher numbers result in slower ramp-up times because estcpu is incremented
394  * once per scheduler tick and maxes out at ESTCPULIM.
395  */
396
397 #define ESTCPURAMP      8                       /* higher equals slower */
398 #define NICE_ADJUST(value)      (((unsigned int)(NICE_WEIGHT * 128) * (value)) / 128)
399 #define ESTCPULIM(v)    min((v), (MAXPRI - NICE_ADJUST(PRIO_MAX - PRIO_MIN)) * ESTCPURAMP)
400 #define NICE_WEIGHT     2.0                     /* priorities per nice level */
401 #define PPQ             ((MAXPRI + 1) / NQS)    /* priorities per queue */
402
403 extern  u_long ps_arg_cache_limit;
404 extern  int ps_argsopen;
405 extern  int ps_showallprocs;
406
407 struct proc *pfind (pid_t);     /* Find process by id. */
408 struct pgrp *pgfind (pid_t);    /* Find process group by id. */
409 struct proc *zpfind (pid_t);    /* Find zombie process by id. */
410
411 struct vm_zone;
412 struct globaldata;
413 extern struct vm_zone *proc_zone;
414
415 int     enterpgrp (struct proc *p, pid_t pgid, int mksess);
416 void    fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
417 int     inferior (struct proc *p);
418 int     leavepgrp (struct proc *p);
419 void    mi_switch (void);
420 void    procinit (void);
421 void    relscurproc(struct proc *curp);
422 int     p_trespass (struct ucred *cr1, struct ucred *cr2);
423 void    resetpriority (struct proc *);
424 int     roundrobin_interval (void);
425 void    resched_cpus(u_int32_t mask);
426 void    schedclock (void *dummy);
427 void    setrunnable (struct proc *);
428 void    clrrunnable (struct proc *, int stat);
429 void    setrunqueue (struct proc *);
430 void    sleepinit (void);
431 int     suser (struct thread *td);
432 int     suser_proc (struct proc *p);
433 int     suser_cred (struct ucred *cred, int flag);
434 void    remrunqueue (struct proc *);
435 void    release_curproc (struct proc *curp);
436 void    acquire_curproc (struct proc *curp);
437 void    cpu_heavy_switch (struct thread *);
438 void    cpu_lwkt_switch (struct thread *);
439 void    unsleep (struct thread *);
440
441 void    cpu_proc_exit (void) __dead2;
442 void    cpu_thread_exit (void) __dead2;
443 void    exit1 (int) __dead2;
444 void    cpu_fork (struct proc *, struct proc *, int);
445 void    cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
446 void    cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
447 int     fork1 (struct proc *, int, struct proc **);
448 void    start_forked_proc (struct proc *, struct proc *);
449 int     trace_req (struct proc *);
450 void    cpu_proc_wait (struct proc *);
451 void    cpu_thread_wait (struct thread *);
452 int     cpu_coredump (struct thread *, struct vnode *, struct ucred *);
453 void    setsugid (void);
454 void    faultin (struct proc *p);
455 void    sched_thread_init(void);
456
457 u_int32_t       procrunnable (void);
458
459 #endif  /* _KERNEL */
460
461 #endif  /* !_SYS_PROC_H_ */