FreeBSD/Linux Kernel Cross Reference
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$
40 */
41
42 #ifndef _SYS_PROC_H_
43 #define _SYS_PROC_H_
44
45 #include <machine/proc.h> /* Machine-dependent proc substruct. */
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 */
56
57 /*
58 * One structure allocated per session.
59 */
60 struct session {
61 int s_count; /* Ref cnt; pgrps in session. */
62 struct proc *s_leader; /* Session leader. */
63 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */
64 struct tty *s_ttyp; /* Controlling terminal. */
65 pid_t s_sid; /* Session ID */
66 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */
67 };
68
69 /*
70 * One structure allocated per process group.
71 */
72 struct pgrp {
73 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */
74 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */
75 struct session *pg_session; /* Pointer to session. */
76 struct sigiolst pg_sigiolst; /* List of sigio sources. */
77 pid_t pg_id; /* Pgrp id. */
78 int pg_jobc; /* # procs qualifying pgrp for job control */
79 };
80
81 struct procsig {
82 sigset_t ps_sigignore; /* Signals being ignored. */
83 sigset_t ps_sigcatch; /* Signals being caught by user. */
84 int ps_flag;
85 struct sigacts *ps_sigacts;
86 int ps_refcnt;
87 };
88
89 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */
90 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */
91
92 /*
93 * pasleep structure, used by asleep() syscall to hold requested priority
94 * and timeout values for await().
95 */
96 struct pasleep {
97 int as_priority; /* Async priority. */
98 int as_timo; /* Async timeout. */
99 };
100
101 /*
102 * pargs, used to hold a copy of the command line, if it had a sane
103 * length
104 */
105 struct pargs {
106 u_int ar_ref; /* Reference count */
107 u_int ar_length; /* Length */
108 u_char ar_args[0]; /* Arguments */
109 };
110
111 /*
112 * Description of a process.
113 *
114 * This structure contains the information needed to manage a thread of
115 * control, known in UN*X as a process; it has references to substructures
116 * containing descriptions of things that the process uses, but may share
117 * with related processes. The process structure and the substructures
118 * are always addressable except for those marked "(PROC ONLY)" below,
119 * which might be addressable only on a processor on which the process
120 * is running.
121 */
122
123 struct jail;
124
125 struct proc {
126 TAILQ_ENTRY(proc) p_procq; /* run/sleep queue. */
127 LIST_ENTRY(proc) p_list; /* List of all processes. */
128
129 /* substructures: */
130 struct pcred *p_cred; /* Process owner's identity. */
131 struct filedesc *p_fd; /* Ptr to open files structure. */
132 struct pstats *p_stats; /* Accounting/statistics (PROC ONLY). */
133 struct plimit *p_limit; /* Process limits. */
134 struct vm_object *p_upages_obj;/* Upages object */
135 struct procsig *p_procsig;
136 #define p_sigacts p_procsig->ps_sigacts
137 #define p_sigignore p_procsig->ps_sigignore
138 #define p_sigcatch p_procsig->ps_sigcatch
139
140 #define p_ucred p_cred->pc_ucred
141 #define p_rlimit p_limit->pl_rlimit
142
143 int p_flag; /* P_* flags. */
144 char p_stat; /* S* process status. */
145 char p_pad1[3];
146
147 pid_t p_pid; /* Process identifier. */
148 LIST_ENTRY(proc) p_hash; /* Hash chain. */
149 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */
150 struct proc *p_pptr; /* Pointer to parent process. */
151 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */
152 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */
153
154 struct callout_handle p_ithandle; /*
155 * Callout handle for scheduling
156 * p_realtimer.
157 */
158 /* The following fields are all zeroed upon creation in fork. */
159 #define p_startzero p_oppid
160
161 pid_t p_oppid; /* Save parent pid during ptrace. XXX */
162 int p_dupfd; /* Sideways return value from fdopen. XXX */
163
164 struct vmspace *p_vmspace; /* Address space. */
165
166 /* scheduling */
167 u_int p_estcpu; /* Time averaged value of p_cpticks. */
168 int p_cpticks; /* Ticks of cpu time. */
169 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
170 void *p_wchan; /* Sleep address. */
171 const char *p_wmesg; /* Reason for sleep. */
172 u_int p_swtime; /* Time swapped in or out. */
173 u_int p_slptime; /* Time since last blocked. */
174
175 struct itimerval p_realtimer; /* Alarm timer. */
176 u_int64_t p_runtime; /* Real time in microsec. */
177 u_int64_t p_uu; /* Previous user time in microsec. */
178 u_int64_t p_su; /* Previous system time in microsec. */
179 u_int64_t p_iu; /* Previous interrupt time in usec. */
180 u_int64_t p_uticks; /* Statclock hits in user mode. */
181 u_int64_t p_sticks; /* Statclock hits in system mode. */
182 u_int64_t p_iticks; /* Statclock hits processing intr. */
183
184 int p_traceflag; /* Kernel trace points. */
185 struct vnode *p_tracep; /* Trace to vnode. */
186
187 sigset_t p_siglist; /* Signals arrived but not delivered. */
188
189 struct vnode *p_textvp; /* Vnode of executable. */
190
191 char p_lock; /* Process lock (prevent swap) count. */
192 u_char p_oncpu; /* Which cpu we are on */
193 u_char p_lastcpu; /* Last cpu we were on */
194 char p_rqindex; /* Run queue index */
195
196 short p_locks; /* DEBUG: lockmgr count of held locks */
197 short p_simple_locks; /* DEBUG: count of held simple locks */
198 unsigned int p_stops; /* procfs event bitmask */
199 unsigned int p_stype; /* procfs stop event type */
200 char p_step; /* procfs stop *once* flag */
201 unsigned char p_pfsflags; /* procfs flags */
202 char p_pad3[2]; /* padding for alignment */
203 register_t p_retval[2]; /* syscall aux returns */
204 struct sigiolst p_sigiolst; /* list of sigio sources */
205 int p_sigparent; /* signal to parent on exit */
206 sigset_t p_oldsigmask; /* saved mask from before sigpause */
207 int p_sig; /* for core dump/debugger XXX */
208 u_long p_code; /* for core dump/debugger XXX */
209 struct klist p_klist; /* knotes attached to this process */
210
211 /* End area that is zeroed on creation. */
212 #define p_endzero p_startcopy
213
214 /* The following fields are all copied upon creation in fork. */
215 #define p_startcopy p_sigmask
216
217 sigset_t p_sigmask; /* Current signal mask. */
218 stack_t p_sigstk; /* sp & on stack state variable */
219 u_char p_priority; /* Process priority. */
220 u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */
221 char p_nice; /* Process "nice" value. */
222 char p_comm[MAXCOMLEN+1];
223
224 struct pgrp *p_pgrp; /* Pointer to process group. */
225
226 struct sysentvec *p_sysent; /* System call dispatch information. */
227
228 struct rtprio p_rtprio; /* Realtime priority. */
229 struct prison *p_prison;
230 struct pargs *p_args;
231 /* End area that is copied on creation. */
232 #define p_endcopy p_addr
233 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY). */
234 struct mdproc p_md; /* Any machine-dependent fields. */
235
236 u_short p_xstat; /* Exit status for wait; also stop signal. */
237 u_short p_acflag; /* Accounting flags. */
238 struct rusage *p_ru; /* Exit information. XXX */
239
240 int p_nthreads; /* number of threads (only in leader) */
241 void *p_aioinfo; /* ASYNC I/O info */
242 int p_wakeup; /* thread id */
243 struct proc *p_peers;
244 struct proc *p_leader;
245 struct pasleep p_asleep; /* Used by asleep()/await(). */
246 void *p_emuldata; /* process-specific emulator state data */
247 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */
248 };
249
250 #define p_session p_pgrp->pg_session
251 #define p_pgid p_pgrp->pg_id
252
253 /* Status values. */
254 #define SIDL 1 /* Process being created by fork. */
255 #define SRUN 2 /* Currently runnable. */
256 #define SSLEEP 3 /* Sleeping on an address. */
257 #define SSTOP 4 /* Process debugging or suspension. */
258 #define SZOMB 5 /* Awaiting collection by parent. */
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. */
266 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */
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. */
270 #define P_TIMEOUT 0x00400 /* Timing out during sleep. */
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
280 /* Should be moved to machine-dependent areas. */
281 #define P_OWEUPC 0x20000 /* Owe process an addupc() call at next ast. */
282
283 #define P_SWAPPING 0x40000 /* Process is being swapped. */
284 #define P_SWAPINREQ 0x80000 /* Swapin request due to wakeup */
285
286 /* Marked a kernel thread */
287 #define P_UNUSED100000 0x100000
288 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */
289
290 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */
291
292 #define P_JAILED 0x1000000 /* Process is in jail */
293 #define P_OLDMASK 0x2000000 /* need to restore mask before pause */
294 #define P_ALTSTACK 0x4000000 /* have alternate signal stack */
295 #define P_INEXEC 0x8000000 /* Process is in execve(). */
296
297 /*
298 * MOVE TO ucred.h?
299 *
300 * Shareable process credentials (always resident). This includes a reference
301 * to the current user credentials as well as real and saved ids that may be
302 * used to change ids.
303 */
304 struct pcred {
305 struct ucred *pc_ucred; /* Current credentials. */
306 uid_t p_ruid; /* Real user id. */
307 uid_t p_svuid; /* Saved effective user id. */
308 gid_t p_rgid; /* Real group id. */
309 gid_t p_svgid; /* Saved effective group id. */
310 int p_refcnt; /* Number of references. */
311 struct uidinfo *p_uidinfo; /* Per uid resource consumption */
312 };
313
314
315 #ifdef _KERNEL
316
317 #ifdef MALLOC_DECLARE
318 MALLOC_DECLARE(M_SESSION);
319 MALLOC_DECLARE(M_SUBPROC);
320 MALLOC_DECLARE(M_ZOMBIE);
321 MALLOC_DECLARE(M_PARGS);
322 #endif
323
324 /* flags for suser_xxx() */
325 #define PRISON_ROOT 1
326
327 /* Handy macro to determine of p1 can mangle p2 */
328
329 #define PRISON_CHECK(p1, p2) \
330 ((!(p1)->p_prison) || (p1)->p_prison == (p2)->p_prison)
331
332 /*
333 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
334 * as it is used to represent "no process group".
335 */
336 #define PID_MAX 99999
337 #define NO_PID 100000
338
339 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
340 #define SESSHOLD(s) ((s)->s_count++)
341 #define SESSRELE(s) { \
342 if (--(s)->s_count == 0) \
343 FREE(s, M_SESSION); \
344 }
345
346 /*
347 * STOPEVENT is MP SAFE.
348 */
349 extern void stopevent(struct proc*, unsigned int, unsigned int);
350 #define STOPEVENT(p,e,v) \
351 do { \
352 if ((p)->p_stops & (e)) { \
353 get_mplock(); \
354 stopevent(p,e,v); \
355 rel_mplock(); \
356 } \
357 } while (0)
358
359 /* hold process U-area in memory, normally for ptrace/procfs work */
360 #define PHOLD(p) { \
361 if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
362 faultin(p); \
363 }
364 #define PRELE(p) (--(p)->p_lock)
365
366 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
367 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
368 extern u_long pidhash;
369
370 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
371 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
372 extern u_long pgrphash;
373
374 #ifndef SET_CURPROC
375 #define SET_CURPROC(p) (curproc = (p))
376 #endif
377
378 #ifndef curproc
379 extern struct proc *curproc; /* Current running proc. */
380 extern u_int astpending; /* software interrupt pending */
381 extern int switchticks; /* `ticks' at last context switch. */
382 extern struct timeval switchtime; /* Uptime at last context switch */
383 #endif
384 extern struct proc proc0; /* Process slot for swapper. */
385 extern int hogticks; /* Limit on kernel cpu hogs. */
386 extern int nprocs, maxproc; /* Current and max number of procs. */
387 extern int maxprocperuid; /* Max procs per uid. */
388 extern int sched_quantum; /* Scheduling quantum in ticks */
389
390 LIST_HEAD(proclist, proc);
391 extern struct proclist allproc; /* List of all processes. */
392 extern struct proclist zombproc; /* List of zombie processes. */
393 extern struct proc *initproc, *pageproc, *updateproc; /* Process slots for init, pager. */
394
395 #define NQS 32 /* 32 run queues. */
396 TAILQ_HEAD(rq, proc);
397 extern struct rq queues[];
398 extern struct rq rtqueues[];
399 extern struct rq idqueues[];
400 extern int whichqs; /* Bit mask summary of non-empty Q's. */
401 extern int whichrtqs; /* Bit mask summary of non-empty Q's. */
402 extern int whichidqs; /* Bit mask summary of non-empty Q's. */
403
404 /*
405 * XXX macros for scheduler. Shouldn't be here, but currently needed for
406 * bounding the dubious p_estcpu inheritance in wait1().
407 * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in
408 * the range 100-256 Hz (approximately).
409 */
410 #define ESTCPULIM(e) \
411 min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * PRIO_MAX - PPQ) + \
412 INVERSE_ESTCPU_WEIGHT - 1)
413 #define INVERSE_ESTCPU_WEIGHT 8 /* 1 / (priorities per estcpu level) */
414 #define NICE_WEIGHT 2 /* priorities per nice level */
415 #define PPQ (128 / NQS) /* priorities per queue */
416
417 extern u_long ps_arg_cache_limit;
418 extern int ps_argsopen;
419
420 struct proc *pfind __P((pid_t)); /* Find process by id. */
421 struct pgrp *pgfind __P((pid_t)); /* Find process group by id. */
422 struct proc *zpfind __P((pid_t)); /* Find zombie process by id. */
423
424 struct vm_zone;
425 extern struct vm_zone *proc_zone;
426
427 int enterpgrp __P((struct proc *p, pid_t pgid, int mksess));
428 void fixjobc __P((struct proc *p, struct pgrp *pgrp, int entering));
429 int inferior __P((struct proc *p));
430 int leavepgrp __P((struct proc *p));
431 void mi_switch __P((void));
432 void procinit __P((void));
433 int p_trespass __P((struct proc *p1, struct proc *p2));
434 void resetpriority __P((struct proc *));
435 int roundrobin_interval __P((void));
436 void schedclock __P((struct proc *));
437 void setrunnable __P((struct proc *));
438 void setrunqueue __P((struct proc *));
439 void sleepinit __P((void));
440 int suser __P((struct proc *));
441 int suser_xxx __P((struct ucred *cred, struct proc *proc, int flag));
442 void remrunqueue __P((struct proc *));
443 void cpu_switch __P((struct proc *));
444 void unsleep __P((struct proc *));
445
446 void cpu_exit __P((struct proc *)) __dead2;
447 void exit1 __P((struct proc *, int)) __dead2;
448 void cpu_fork __P((struct proc *, struct proc *, int));
449 void cpu_set_fork_handler __P((struct proc *, void (*)(void *), void *));
450 int fork1 __P((struct proc *, int, struct proc **));
451 int trace_req __P((struct proc *));
452 void cpu_wait __P((struct proc *));
453 int cpu_coredump __P((struct proc *, struct vnode *, struct ucred *));
454 void setsugid __P((struct proc *p));
455 void faultin __P((struct proc *p));
456
457 struct proc * chooseproc __P((void));
458 u_int32_t procrunnable __P((void));
459
460 #endif /* _KERNEL */
461
462 #endif /* !_SYS_PROC_H_ */
Cache object: df7ca6439e4daaa3264ef14bfe53a0b5
|