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