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