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.28 2003/07/26 20:58:09 hmp Exp $ 41 */ 42 43 #ifndef _SYS_PROC_H_ 44 #define _SYS_PROC_H_ 45 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 #include <sys/thread.h> 57 #include <sys/globaldata.h> 58 #include <machine/proc.h> /* Machine-dependent proc substruct. */ 59 60 /* 61 * One structure allocated per session. 62 */ 63 struct session { 64 int s_count; /* Ref cnt; pgrps in session. */ 65 struct proc *s_leader; /* Session leader. */ 66 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */ 67 struct tty *s_ttyp; /* Controlling terminal. */ 68 pid_t s_sid; /* Session ID */ 69 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */ 70 }; 71 72 /* 73 * One structure allocated per process group. 74 */ 75 struct pgrp { 76 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */ 77 LIST_HEAD(, proc) pg_members; /* Pointer to pgrp members. */ 78 struct session *pg_session; /* Pointer to session. */ 79 struct sigiolst pg_sigiolst; /* List of sigio sources. */ 80 pid_t pg_id; /* Pgrp id. */ 81 int pg_jobc; /* # procs qualifying pgrp for job control */ 82 }; 83 84 struct procsig { 85 sigset_t ps_sigignore; /* Signals being ignored. */ 86 sigset_t ps_sigcatch; /* Signals being caught by user. */ 87 int ps_flag; 88 struct sigacts *ps_sigacts; 89 int ps_refcnt; 90 }; 91 92 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */ 93 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */ 94 95 /* 96 * pargs, used to hold a copy of the command line, if it had a sane 97 * length 98 */ 99 struct pargs { 100 u_int ar_ref; /* Reference count */ 101 u_int ar_length; /* Length */ 102 u_char ar_args[0]; /* Arguments */ 103 }; 104 105 /* 106 * Description of a process. 107 * 108 * This structure contains the information needed to manage a thread of 109 * control, known in UN*X as a process; it has references to substructures 110 * containing descriptions of things that the process uses, but may share 111 * with related processes. The process structure and the substructures 112 * are always addressable except for those marked "(PROC ONLY)" below, 113 * which might be addressable only on a processor on which the process 114 * is running. 115 */ 116 117 struct jail; 118 119 struct proc { 120 TAILQ_ENTRY(proc) p_procq; /* run/sleep queue. */ 121 LIST_ENTRY(proc) p_list; /* List of all processes. */ 122 123 /* substructures: */ 124 struct ucred *p_ucred; /* Process owner's identity. */ 125 struct filedesc *p_fd; /* Ptr to open files structure. */ 126 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node */ 127 struct pstats *p_stats; /* Accounting/statistics (PROC ONLY). */ 128 struct plimit *p_limit; /* Process limits. */ 129 #if 0 130 struct vm_object *p_upages_obj;/* Upages object */ 131 #else 132 void *p_dummy1; 133 #endif 134 struct procsig *p_procsig; 135 #define p_sigacts p_procsig->ps_sigacts 136 #define p_sigignore p_procsig->ps_sigignore 137 #define p_sigcatch p_procsig->ps_sigcatch 138 #define p_rlimit p_limit->pl_rlimit 139 140 int p_flag; /* P_* flags. */ 141 char p_stat; /* S* process status. */ 142 char p_pad1[3]; 143 144 pid_t p_pid; /* Process identifier. */ 145 LIST_ENTRY(proc) p_hash; /* Hash chain. */ 146 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */ 147 struct proc *p_pptr; /* Pointer to parent process. */ 148 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */ 149 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */ 150 151 struct callout_handle p_ithandle; /* 152 * Callout handle for scheduling 153 * p_realtimer. 154 */ 155 /* The following fields are all zeroed upon creation in fork. */ 156 #define p_startzero p_oppid 157 158 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 159 int p_dupfd; /* Sideways return value from fdopen. XXX */ 160 161 struct vmspace *p_vmspace; /* Address space. */ 162 163 /* scheduling */ 164 u_int p_estcpu; /* Time averaged value of p_cpticks. */ 165 int p_cpticks; /* Ticks of cpu time. */ 166 fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */ 167 u_int p_swtime; /* Time swapped in or out. */ 168 u_int p_slptime; /* Time since last blocked. */ 169 170 struct itimerval p_realtimer; /* Alarm timer. */ 171 172 int p_traceflag; /* Kernel trace points. */ 173 struct vnode *p_tracep; /* Trace to vnode. */ 174 175 sigset_t p_siglist; /* Signals arrived but not delivered. */ 176 177 struct vnode *p_textvp; /* Vnode of executable. */ 178 179 char p_lock; /* Process lock (prevent swap) count. */ 180 u_char p_unused01; /* Which cpu we are on */ 181 u_char p_unused02; /* Last cpu we were on */ 182 char p_rqindex; /* Run queue index */ 183 184 unsigned int p_stops; /* procfs event bitmask */ 185 unsigned int p_stype; /* procfs stop event type */ 186 char p_step; /* procfs stop *once* flag */ 187 unsigned char p_pfsflags; /* procfs flags */ 188 char p_pad3[2]; /* padding for alignment */ 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 */ 204 u_char p_priority; /* Tracks user sched queue */ 205 char p_nice; /* Process "nice" value. */ 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. */ 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; 227 void *p_emuldata; /* process-specific emulator state data */ 228 struct thread *p_thread; /* temporarily embed thread struct in proc */ 229 }; 230 231 #if defined(_KERNEL) 232 #define p_wchan p_thread->td_wchan 233 #define p_wmesg p_thread->td_wmesg 234 #define p_comm p_thread->td_comm 235 #define p_session p_pgrp->pg_session 236 #define p_pgid p_pgrp->pg_id 237 #endif 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. */ 245 #define STHREAD 6 /* Synthesized for eproc only */ 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. */ 253 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */ 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. */ 257 #define P_CURPROC 0x00400 /* 'Current process' on this cpu */ 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 #define P_UNUSED20000 0x20000 268 269 #define P_SWAPPING 0x40000 /* Process is being swapped. */ 270 #define P_SWAPINREQ 0x80000 /* Swapin request due to wakeup */ 271 272 /* Marked a kernel thread */ 273 #define P_ONRUNQ 0x100000 /* on a user scheduling run queue */ 274 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */ 275 #define P_CP_RELEASED 0x400000 /* directly schedule LWKT, ignore user schd */ 276 277 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */ 278 279 #define P_JAILED 0x1000000 /* Process is in jail */ 280 #define P_OLDMASK 0x2000000 /* need to restore mask before pause */ 281 #define P_ALTSTACK 0x4000000 /* have alternate signal stack */ 282 #define P_INEXEC 0x8000000 /* Process is in execve(). */ 283 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */ 284 285 #ifdef _KERNEL 286 287 #ifdef MALLOC_DECLARE 288 MALLOC_DECLARE(M_SESSION); 289 MALLOC_DECLARE(M_SUBPROC); 290 MALLOC_DECLARE(M_ZOMBIE); 291 MALLOC_DECLARE(M_PARGS); 292 #endif 293 294 /* flags for suser_xxx() */ 295 #define PRISON_ROOT 1 296 297 /* Handy macro to determine if p1 can mangle p2 */ 298 299 #define PRISON_CHECK(cr1, cr2) \ 300 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison) 301 302 /* 303 * Handy macro for LISTs. 304 */ 305 #define FOREACH_PROC_IN_SYSTEM(p) LIST_FOREACH((p), &allproc, p_list) 306 307 /* 308 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 309 * as it is used to represent "no process group". 310 */ 311 #define PID_MAX 99999 312 #define NO_PID 100000 313 314 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p)) 315 #define SESSHOLD(s) ((s)->s_count++) 316 #define SESSRELE(s) { \ 317 if (--(s)->s_count == 0) \ 318 FREE(s, M_SESSION); \ 319 } 320 321 /* 322 * STOPEVENT 323 */ 324 extern void stopevent(struct proc*, unsigned int, unsigned int); 325 #define STOPEVENT(p,e,v) \ 326 do { \ 327 if ((p)->p_stops & (e)) { \ 328 stopevent(p,e,v); \ 329 } \ 330 } while (0) 331 332 /* hold process U-area in memory, normally for ptrace/procfs work */ 333 #define PHOLD(p) { \ 334 if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \ 335 faultin(p); \ 336 } 337 #define PRELE(p) (--(p)->p_lock) 338 339 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash]) 340 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl; 341 extern u_long pidhash; 342 343 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash]) 344 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl; 345 extern u_long pgrphash; 346 347 #if 0 348 #ifndef SET_CURPROC 349 #define SET_CURPROC(p) (curproc = (p)) 350 #endif 351 #endif 352 353 extern struct proc proc0; /* Process slot for swapper. */ 354 extern struct thread thread0; /* Thread slot for swapper. */ 355 extern int hogticks; /* Limit on kernel cpu hogs. */ 356 extern int nprocs, maxproc; /* Current and max number of procs. */ 357 extern int maxprocperuid; /* Max procs per uid. */ 358 extern int sched_quantum; /* Scheduling quantum in ticks */ 359 360 LIST_HEAD(proclist, proc); 361 extern struct proclist allproc; /* List of all processes. */ 362 extern struct proclist zombproc; /* List of zombie processes. */ 363 extern struct proc *initproc; /* Process slot for init */ 364 extern struct thread *pagethread, *updatethread; 365 366 #define NQS 32 /* 32 run queues. */ 367 TAILQ_HEAD(rq, proc); 368 extern struct rq queues[]; 369 extern struct rq rtqueues[]; 370 extern struct rq idqueues[]; 371 extern int whichqs; /* Bit mask summary of non-empty Q's. */ 372 extern int whichrtqs; /* Bit mask summary of non-empty Q's. */ 373 extern int whichidqs; /* Bit mask summary of non-empty Q's. */ 374 375 /* 376 * XXX macros for scheduler. Shouldn't be here, but currently needed for 377 * bounding the dubious p_estcpu inheritance in wait1(). 378 * INVERSE_ESTCPU_WEIGHT is only suitable for statclock() frequencies in 379 * the range 100-256 Hz (approximately). 380 */ 381 #define ESTCPULIM(e) \ 382 min((e), INVERSE_ESTCPU_WEIGHT * (NICE_WEIGHT * PRIO_MAX - PPQ) + \ 383 INVERSE_ESTCPU_WEIGHT - 1) 384 #define INVERSE_ESTCPU_WEIGHT 8 /* 1 / (priorities per estcpu level) */ 385 #define NICE_WEIGHT 2 /* priorities per nice level */ 386 #define PPQ (128 / NQS) /* priorities per queue */ 387 388 extern u_long ps_arg_cache_limit; 389 extern int ps_argsopen; 390 391 struct proc *pfind __P((pid_t)); /* Find process by id. */ 392 struct pgrp *pgfind __P((pid_t)); /* Find process group by id. */ 393 struct proc *zpfind __P((pid_t)); /* Find zombie process by id. */ 394 395 struct vm_zone; 396 struct globaldata; 397 extern struct vm_zone *proc_zone; 398 399 int enterpgrp __P((struct proc *p, pid_t pgid, int mksess)); 400 void fixjobc __P((struct proc *p, struct pgrp *pgrp, int entering)); 401 int inferior __P((struct proc *p)); 402 int leavepgrp __P((struct proc *p)); 403 void mi_switch __P((void)); 404 void procinit __P((void)); 405 void relscurproc(struct proc *curp); 406 int p_trespass __P((struct ucred *cr1, struct ucred *cr2)); 407 void resetpriority __P((struct proc *)); 408 int roundrobin_interval __P((void)); 409 void resched_cpus(u_int32_t mask); 410 void schedclock __P((struct proc *)); 411 void setrunnable __P((struct proc *)); 412 void clrrunnable __P((struct proc *, int stat)); 413 void setrunqueue __P((struct proc *)); 414 void sleepinit __P((void)); 415 int suser __P((struct thread *td)); 416 int suser_proc __P((struct proc *p)); 417 int suser_cred __P((struct ucred *cred, int flag)); 418 void remrunqueue __P((struct proc *)); 419 void release_curproc __P((struct proc *curp)); 420 void acquire_curproc __P((struct proc *curp)); 421 void cpu_heavy_switch __P((struct thread *)); 422 void cpu_lwkt_switch __P((struct thread *)); 423 void unsleep __P((struct thread *)); 424 425 void cpu_proc_exit __P((void)) __dead2; 426 void cpu_thread_exit __P((void)) __dead2; 427 void exit1 __P((int)) __dead2; 428 void cpu_fork __P((struct proc *, struct proc *, int)); 429 void cpu_set_fork_handler __P((struct proc *, void (*)(void *), void *)); 430 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg); 431 int fork1 __P((struct proc *, int, struct proc **)); 432 void start_forked_proc __P((struct proc *, struct proc *)); 433 int trace_req __P((struct proc *)); 434 void cpu_proc_wait __P((struct proc *)); 435 void cpu_thread_wait __P((struct thread *)); 436 int cpu_coredump __P((struct thread *, struct vnode *, struct ucred *)); 437 void setsugid __P((void)); 438 void faultin __P((struct proc *p)); 439 void sched_thread_init(void); 440 441 u_int32_t procrunnable __P((void)); 442 443 #endif /* _KERNEL */ 444 445 #endif /* !_SYS_PROC_H_ */ 446