* Remove a procedural layer in the scheduler clock code by having
[dragonfly.git] / sys / sys / proc.h
CommitLineData
984263bc
MD
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 $
dcc99b62 40 * $DragonFly: src/sys/sys/proc.h,v 1.61 2005/06/27 18:37:59 dillon Exp $
984263bc
MD
41 */
42
43#ifndef _SYS_PROC_H_
44#define _SYS_PROC_H_
45
05220613
MD
46#if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
47#error "Userland must include sys/user.h instead of sys/proc.h"
48#endif
49
984263bc
MD
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 */
84b592ba 60#include <sys/thread.h>
98a7f915 61#include <sys/varsym.h>
a722be49 62#include <sys/upcall.h>
ec12abe0 63#ifdef _KERNEL
a2a5ad0d 64#include <sys/globaldata.h>
ec12abe0 65#endif
dcc99b62 66#include <sys/systimer.h>
a77ac49d 67#include <sys/usched.h>
3020e3be 68#include <machine/proc.h> /* Machine-dependent proc substruct. */
84b592ba 69
984263bc
MD
70/*
71 * One structure allocated per session.
72 */
73struct session {
74 int s_count; /* Ref cnt; pgrps in session. */
75 struct proc *s_leader; /* Session leader. */
76 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
77 struct tty *s_ttyp; /* Controlling terminal. */
78 pid_t s_sid; /* Session ID */
79 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
80};
81
82/*
83 * One structure allocated per process group.
84 */
85struct pgrp {
86 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
87 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
88 struct session *pg_session; /* Pointer to session. */
89 struct sigiolst pg_sigiolst; /* List of sigio sources. */
90 pid_t pg_id; /* Pgrp id. */
91 int pg_jobc; /* # procs qualifying pgrp for job control */
92};
93
94struct procsig {
95 sigset_t ps_sigignore; /* Signals being ignored. */
96 sigset_t ps_sigcatch; /* Signals being caught by user. */
97 int ps_flag;
98 struct sigacts *ps_sigacts;
99 int ps_refcnt;
100};
101
102#define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
103#define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
104
984263bc
MD
105/*
106 * pargs, used to hold a copy of the command line, if it had a sane
107 * length
108 */
109struct pargs {
110 u_int ar_ref; /* Reference count */
111 u_int ar_length; /* Length */
112 u_char ar_args[0]; /* Arguments */
113};
114
115/*
116 * Description of a process.
117 *
118 * This structure contains the information needed to manage a thread of
119 * control, known in UN*X as a process; it has references to substructures
120 * containing descriptions of things that the process uses, but may share
121 * with related processes. The process structure and the substructures
122 * are always addressable except for those marked "(PROC ONLY)" below,
123 * which might be addressable only on a processor on which the process
124 * is running.
41f3429e
HP
125 *
126 * NOTE! The process start time is stored in the thread structure associated
127 * with the process. If the process is a Zombie, then this field will be
128 * inaccessible due to the thread structure being free'd in kern_wait1().
984263bc
MD
129 */
130
131struct jail;
132
133struct proc {
134 TAILQ_ENTRY(proc) p_procq; /* run/sleep queue. */
135 LIST_ENTRY(proc) p_list; /* List of all processes. */
136
137 /* substructures: */
c46d7673
MD
138 struct ucred *p_ucred; /* Process owner's identity. */
139 struct filedesc *p_fd; /* Ptr to open files structure. */
984263bc 140 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */
c46d7673
MD
141 struct pstats *p_stats; /* Accounting/statistics (PROC ONLY). */
142 struct plimit *p_limit; /* Process limits. */
143 void *p_pad0;
984263bc
MD
144 struct procsig *p_procsig;
145#define p_sigacts p_procsig->ps_sigacts
146#define p_sigignore p_procsig->ps_sigignore
147#define p_sigcatch p_procsig->ps_sigcatch
984263bc
MD
148#define p_rlimit p_limit->pl_rlimit
149
c46d7673
MD
150 int p_flag; /* P_* flags. */
151 char p_stat; /* S* process status. */
152 char p_pad1[3];
984263bc 153
c46d7673 154 pid_t p_pid; /* Process identifier. */
984263bc
MD
155 LIST_ENTRY(proc) p_hash; /* Hash chain. */
156 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
c46d7673 157 struct proc *p_pptr; /* Pointer to parent process. */
984263bc
MD
158 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
159 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */
c46d7673
MD
160 struct callout p_ithandle; /* for scheduling p_realtimer */
161 struct varsymset p_varsymset;
984263bc 162
984263bc
MD
163/* The following fields are all zeroed upon creation in fork. */
164#define p_startzero p_oppid
165
c46d7673
MD
166 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
167 int p_dupfd; /* Sideways return value from fdopen. XXX */
984263bc 168
c46d7673 169 struct vmspace *p_vmspace; /* Address space. */
984263bc 170
dcc99b62
MD
171 /*
172 * Scheduling.
173 */
174 sysclock_t p_cpticks; /* cpu used in sched clock ticks */
175 sysclock_t p_cpbase; /* Measurement base */
c46d7673
MD
176 fixpt_t p_pctcpu; /* %cpu for this process */
177 u_int p_swtime; /* Time swapped in or out. */
178 u_int p_slptime; /* Time since last blocked. */
984263bc 179
c46d7673 180 struct itimerval p_realtimer; /* Alarm timer. */
984263bc 181
c46d7673
MD
182 int p_traceflag; /* Kernel trace points. */
183 struct vnode *p_tracep; /* Trace to vnode. */
984263bc 184
c46d7673 185 sigset_t p_siglist; /* Signals arrived but not delivered. */
984263bc 186
c46d7673 187 struct vnode *p_textvp; /* Vnode of executable. */
984263bc 188
352f5709 189 union usched_data p_usdata; /* User scheduler specific */
c46d7673 190
984263bc
MD
191 unsigned int p_stops; /* procfs event bitmask */
192 unsigned int p_stype; /* procfs stop event type */
c46d7673 193 char p_step; /* procfs stop *once* flag */
984263bc 194 unsigned char p_pfsflags; /* procfs flags */
352f5709 195 char p_pad2[2]; /* padding for alignment */
c46d7673
MD
196 struct sigiolst p_sigiolst; /* list of sigio sources */
197 int p_sigparent; /* signal to parent on exit */
198 sigset_t p_oldsigmask; /* saved mask from before sigpause */
199 int p_sig; /* for core dump/debugger XXX */
200 u_long p_code; /* for core dump/debugger XXX */
201 struct klist p_klist; /* knotes attached to this process */
984263bc
MD
202
203/* End area that is zeroed on creation. */
204#define p_endzero p_startcopy
205
206/* The following fields are all copied upon creation in fork. */
207#define p_startcopy p_sigmask
208
c46d7673
MD
209 sigset_t p_sigmask; /* Current signal mask. */
210 stack_t p_sigstk; /* sp & on stack state variable */
352f5709 211 char p_lock; /* Process lock (prevent swap) count. */
c46d7673 212 char p_nice; /* Process "nice" value. */
352f5709 213 char p_pad3[2];
984263bc 214
c46d7673 215 struct pgrp *p_pgrp; /* Pointer to process group. */
984263bc 216
c46d7673 217 struct sysentvec *p_sysent; /* System call dispatch information. */
984263bc 218
c46d7673
MD
219 struct rtprio p_rtprio; /* Realtime priority. */
220 struct pargs *p_args;
984263bc
MD
221/* End area that is copied on creation. */
222#define p_endcopy p_addr
c46d7673
MD
223 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY) */
224 struct mdproc p_md; /* Any machine-dependent fields. */
225
226 u_short p_xstat; /* Exit status or last stop signal */
227 u_short p_acflag; /* Accounting flags. */
228 struct rusage *p_ru; /* Exit information. XXX */
229
230 int p_nthreads; /* number of threads (only in leader) */
231 void *p_aioinfo; /* ASYNC I/O info */
232 int p_wakeup; /* thread id */
233 struct proc *p_peers;
234 struct proc *p_leader;
235 void *p_emuldata; /* process-specific emulator state */
236 struct thread *p_thread; /* backpointer to proc's thread */
237 struct upcall *p_upcall; /* REGISTERED USERLAND POINTER! */
238 struct usched *p_usched; /* Userland scheduling control */
239 int p_numposixlocks; /* number of POSIX locks */
1fa2b4b4 240 TAILQ_HEAD(, sysmsg) p_sysmsgq; /* Recorded asynch system calls */
c46d7673 241 int p_num_sysmsg; /* Number of asynch messages running */
984263bc
MD
242};
243
b8acf5a9 244#if defined(_KERNEL)
0cfcada1
MD
245#define p_wchan p_thread->td_wchan
246#define p_wmesg p_thread->td_wmesg
73e4f7b9 247#define p_comm p_thread->td_comm
984263bc
MD
248#define p_session p_pgrp->pg_session
249#define p_pgid p_pgrp->pg_id
b8acf5a9 250#endif
984263bc
MD
251
252/* Status values. */
253#define SIDL 1 /* Process being created by fork. */
254#define SRUN 2 /* Currently runnable. */
255#define SSLEEP 3 /* Sleeping on an address. */
256#define SSTOP 4 /* Process debugging or suspension. */
257#define SZOMB 5 /* Awaiting collection by parent. */
73e4f7b9 258#define STHREAD 6 /* Synthesized for eproc only */
984263bc
MD
259
260/* These flags are kept in p_flags. */
261#define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
262#define P_CONTROLT 0x00002 /* Has a controlling terminal. */
263#define P_INMEM 0x00004 /* Loaded into memory. */
264#define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
265#define P_PROFIL 0x00020 /* Has started profiling. */
dadab5e9 266#define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
984263bc
MD
267#define P_SINTR 0x00080 /* Sleep is interruptible. */
268#define P_SUGID 0x00100 /* Had set id privileges since last exec. */
269#define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
0a3f9b47 270#define P_UNUSED00400 0x00400
984263bc
MD
271#define P_TRACED 0x00800 /* Debugged process being traced. */
272#define P_WAITED 0x01000 /* Debugging process has waited for child. */
273#define P_WEXIT 0x02000 /* Working on exiting. */
274#define P_EXEC 0x04000 /* Process called exec. */
275
276/* Should probably be changed into a hold count. */
277/* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */
278/* was P_PHYSIO 0x10000 was: Doing physical I/O; use p->p_hold */
279
a722be49 280#define P_UPCALLPEND 0x20000 /* an upcall is pending */
984263bc
MD
281
282#define P_SWAPPING 0x40000 /* Process is being swapped. */
283#define P_SWAPINREQ 0x80000 /* Swapin request due to wakeup */
284
285/* Marked a kernel thread */
a2a5ad0d 286#define P_ONRUNQ 0x100000 /* on a user scheduling run queue */
984263bc 287#define P_KTHREADP 0x200000 /* Process is really a kernel thread */
8ec60c3f 288#define P_UNUSED400000 0x400000
984263bc
MD
289#define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
290
291#define P_JAILED 0x1000000 /* Process is in jail */
292#define P_OLDMASK 0x2000000 /* need to restore mask before pause */
293#define P_ALTSTACK 0x4000000 /* have alternate signal stack */
294#define P_INEXEC 0x8000000 /* Process is in execve(). */
d9eea1a5 295#define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */
fe8c5e17 296#define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */
984263bc 297
984263bc
MD
298#ifdef _KERNEL
299
300#ifdef MALLOC_DECLARE
301MALLOC_DECLARE(M_SESSION);
302MALLOC_DECLARE(M_SUBPROC);
303MALLOC_DECLARE(M_ZOMBIE);
304MALLOC_DECLARE(M_PARGS);
305#endif
306
307/* flags for suser_xxx() */
e4700d00
JH
308#define PRISON_ROOT 0x1
309#define NULL_CRED_OKAY 0x2
984263bc 310
95db0b6a 311/* Handy macro to determine if p1 can mangle p2 */
984263bc 312
41c20dac
MD
313#define PRISON_CHECK(cr1, cr2) \
314 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
984263bc 315
95db0b6a
HP
316/*
317 * Handy macro for LISTs.
318 */
319#define FOREACH_PROC_IN_SYSTEM(p) LIST_FOREACH((p), &allproc, p_list)
320
984263bc
MD
321/*
322 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
323 * as it is used to represent "no process group".
324 */
325#define PID_MAX 99999
326#define NO_PID 100000
327
328#define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
984263bc
MD
329
330/*
8a8d5d85 331 * STOPEVENT
984263bc
MD
332 */
333extern void stopevent(struct proc*, unsigned int, unsigned int);
334#define STOPEVENT(p,e,v) \
335 do { \
336 if ((p)->p_stops & (e)) { \
984263bc 337 stopevent(p,e,v); \
984263bc
MD
338 } \
339 } while (0)
340
341/* hold process U-area in memory, normally for ptrace/procfs work */
342#define PHOLD(p) { \
343 if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
344 faultin(p); \
345}
346#define PRELE(p) (--(p)->p_lock)
347
348#define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
349extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
350extern u_long pidhash;
351
352#define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
353extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
354extern u_long pgrphash;
355
84b592ba 356#if 0
984263bc
MD
357#ifndef SET_CURPROC
358#define SET_CURPROC(p) (curproc = (p))
359#endif
984263bc 360#endif
84b592ba 361
984263bc 362extern struct proc proc0; /* Process slot for swapper. */
b7c628e4 363extern struct thread thread0; /* Thread slot for swapper. */
984263bc
MD
364extern int hogticks; /* Limit on kernel cpu hogs. */
365extern int nprocs, maxproc; /* Current and max number of procs. */
366extern int maxprocperuid; /* Max procs per uid. */
367extern int sched_quantum; /* Scheduling quantum in ticks */
368
369LIST_HEAD(proclist, proc);
370extern struct proclist allproc; /* List of all processes. */
371extern struct proclist zombproc; /* List of zombie processes. */
bc6dffab
MD
372extern struct proc *initproc; /* Process slot for init */
373extern struct thread *pagethread, *updatethread;
984263bc 374
984263bc 375/*
a46fac56
MD
376 * Scheduler independant variables. The primary scheduler polling frequency,
377 * the maximum ESTCPU value, and the weighting factor for nice values. A
378 * cpu bound program's estcpu will increase to ESTCPUMAX - 1.
984263bc 379 */
a46fac56 380#define ESTCPUFREQ 50
984263bc
MD
381
382extern u_long ps_arg_cache_limit;
383extern int ps_argsopen;
28c57d20 384extern int ps_showallprocs;
984263bc 385
b153f746
RG
386struct proc *pfind (pid_t); /* Find process by id. */
387struct pgrp *pgfind (pid_t); /* Find process group by id. */
388struct proc *zpfind (pid_t); /* Find zombie process by id. */
984263bc
MD
389
390struct vm_zone;
a2a5ad0d 391struct globaldata;
984263bc
MD
392extern struct vm_zone *proc_zone;
393
b153f746
RG
394int enterpgrp (struct proc *p, pid_t pgid, int mksess);
395void fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
dcc99b62 396void updatepcpu(struct proc *, int, int);
b153f746
RG
397int inferior (struct proc *p);
398int leavepgrp (struct proc *p);
8b90699b
MD
399void sess_hold(struct session *sp);
400void sess_rele(struct session *sp);
37af14fe 401void mi_switch (struct proc *p);
b153f746 402void procinit (void);
26a0694b 403void relscurproc(struct proc *curp);
b153f746 404int p_trespass (struct ucred *cr1, struct ucred *cr2);
b153f746
RG
405void setrunnable (struct proc *);
406void clrrunnable (struct proc *, int stat);
b153f746
RG
407void sleepinit (void);
408int suser (struct thread *td);
409int suser_proc (struct proc *p);
410int suser_cred (struct ucred *cred, int flag);
b153f746
RG
411void cpu_heavy_switch (struct thread *);
412void cpu_lwkt_switch (struct thread *);
413void unsleep (struct thread *);
414
415void cpu_proc_exit (void) __dead2;
416void cpu_thread_exit (void) __dead2;
417void exit1 (int) __dead2;
418void cpu_fork (struct proc *, struct proc *, int);
419void cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
0cfcada1 420void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
b153f746
RG
421int fork1 (struct proc *, int, struct proc **);
422void start_forked_proc (struct proc *, struct proc *);
423int trace_req (struct proc *);
424void cpu_proc_wait (struct proc *);
425void cpu_thread_wait (struct thread *);
426int cpu_coredump (struct thread *, struct vnode *, struct ucred *);
427void setsugid (void);
428void faultin (struct proc *p);
984263bc 429
b153f746 430u_int32_t procrunnable (void);
984263bc
MD
431
432#endif /* _KERNEL */
433
434#endif /* !_SYS_PROC_H_ */