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.91 2007/02/01 10:33:26 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 struct lwp { 141 TAILQ_ENTRY(lwp) lwp_procq; /* run/sleep queue. */ 142 LIST_ENTRY(lwp) lwp_list; /* List of all threads in the proc. */ 143 144 struct proc *lwp_proc; /* Link to our proc. */ 145 146 lwpid_t lwp_tid; /* Our thread id . */ 147 148 #ifdef notyet 149 int lwp_flag; /* P_* flags. */ 150 char lwp_stat; /* S* process status. */ 151 #endif 152 153 #define lwp_startzero lwp_dupfd 154 int lwp_dupfd; /* Sideways return value from fdopen. XXX */ 155 156 /* 157 * Scheduling. 158 */ 159 sysclock_t lwp_cpticks; /* cpu used in sched clock ticks */ 160 sysclock_t lwp_cpbase; /* Measurement base */ 161 fixpt_t lwp_pctcpu; /* %cpu for this process */ 162 u_int lwp_swtime; /* Time swapped in or out. */ 163 u_int lwp_slptime; /* Time since last blocked. */ 164 165 int lwp_traceflag; /* Kernel trace points. */ 166 167 struct rusage lwp_ru; /* stats for this lwp */ 168 169 union usched_data lwp_usdata; /* User scheduler specific */ 170 #define lwp_endzero lwp_startcopy 171 172 #define lwp_startcopy lwp_cpumask 173 cpumask_t lwp_cpumask; 174 sigset_t lwp_siglist; /* Signals arrived but not delivered. */ 175 sigset_t lwp_oldsigmask; /* saved mask from before sigpause */ 176 sigset_t lwp_sigmask; /* Current signal mask. */ 177 stack_t lwp_sigstk; /* sp & on stack state variable */ 178 179 struct rtprio lwp_rtprio; /* Realtime priority. */ 180 #define lwp_endcopy lwp_md 181 182 struct mdproc lwp_md; /* Any machine-dependent fields. */ 183 184 struct thread *lwp_thread; /* backpointer to proc's thread */ 185 struct upcall *lwp_upcall; /* REGISTERED USERLAND POINTER! */ 186 }; 187 188 struct proc { 189 LIST_ENTRY(proc) p_list; /* List of all processes. */ 190 191 /* substructures: */ 192 struct ucred *p_ucred; /* Process owner's identity. */ 193 struct filedesc *p_fd; /* Ptr to open files structure. */ 194 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */ 195 struct plimit *p_limit; /* Process limits. */ 196 void *p_pad0; 197 struct procsig *p_procsig; 198 #define p_sigacts p_procsig->ps_sigacts 199 #define p_sigignore p_procsig->ps_sigignore 200 #define p_sigcatch p_procsig->ps_sigcatch 201 #define p_rlimit p_limit->pl_rlimit 202 203 int p_flag; /* P_* flags. */ 204 char p_stat; /* S* process status. */ 205 char p_pad1[3]; 206 207 pid_t p_pid; /* Process identifier. */ 208 LIST_ENTRY(proc) p_hash; /* Hash chain. */ 209 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */ 210 struct proc *p_pptr; /* Pointer to parent process. */ 211 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */ 212 LIST_HEAD(, proc) p_children; /* Pointer to list of children. */ 213 struct callout p_ithandle; /* for scheduling p_realtimer */ 214 struct varsymset p_varsymset; 215 216 /* The following fields are all zeroed upon creation in fork. */ 217 #define p_startzero p_oppid 218 219 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 220 221 struct vmspace *p_vmspace; /* Current address space. */ 222 223 #define p_cpticks p_lwp.lwp_cpticks 224 #define p_cpbase p_lwp.lwp_cpbase 225 #define p_pctcpu p_lwp.lwp_pctcpu 226 #define p_swtime p_lwp.lwp_swtime 227 #define p_slptime p_lwp.lwp_slptime 228 229 struct itimerval p_realtimer; /* Alarm timer. */ 230 struct itimerval p_timer[3]; /* Virtual-time timers. */ 231 232 int p_traceflag; /* Kernel trace points. */ 233 struct ktrace_node *p_tracenode; /* Trace to vnode. */ 234 235 sigset_t p_siglist; /* Signals arrived but not delivered. */ 236 237 struct vnode *p_textvp; /* Vnode of executable. */ 238 239 #define p_usdata p_lwp.lwp_usdata 240 241 unsigned int p_stops; /* procfs event bitmask */ 242 unsigned int p_stype; /* procfs stop event type */ 243 char p_step; /* procfs stop *once* flag */ 244 unsigned char p_pfsflags; /* procfs flags */ 245 char p_pad2[2]; /* padding for alignment */ 246 struct sigiolst p_sigiolst; /* list of sigio sources */ 247 int p_sigparent; /* signal to parent on exit */ 248 #define p_oldsigmask p_lwp.lwp_oldsigmask 249 int p_sig; /* for core dump/debugger XXX */ 250 u_long p_code; /* for core dump/debugger XXX */ 251 struct klist p_klist; /* knotes attached to this process */ 252 253 struct timeval p_start; /* start time for a process */ 254 255 struct rusage p_ru; /* stats for this proc */ 256 struct rusage p_cru; /* sum of stats for reaped children */ 257 258 /* End area that is zeroed on creation. */ 259 #define p_endzero p_startcopy 260 261 /* The following fields are all copied upon creation in fork. */ 262 #define p_startcopy p_comm 263 264 #define p_sigmask p_lwp.lwp_sigmask 265 #define p_sigstk p_lwp.lwp_sigstk 266 267 char p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */ 268 char p_lock; /* Process lock (prevent swap) count. */ 269 char p_nice; /* Process "nice" value. */ 270 char p_pad3; 271 272 struct pgrp *p_pgrp; /* Pointer to process group. */ 273 274 struct sysentvec *p_sysent; /* System call dispatch information. */ 275 276 struct uprof p_prof; /* Profiling arguments. */ 277 struct rtprio p_rtprio; /* Realtime priority. */ 278 struct pargs *p_args; 279 /* End area that is copied on creation. */ 280 #define p_endcopy p_addr 281 struct user *p_addr; /* Kernel virtual addr of u-area (PROC ONLY) XXX lwp */ 282 #define p_md p_lwp.lwp_md 283 284 u_short p_xstat; /* Exit status or last stop signal */ 285 u_short p_acflag; /* Accounting flags. */ 286 287 int p_nthreads; /* Number of threads in this process. */ 288 int p_nstopped; /* Number of stopped threads. */ 289 int p_lasttid; /* Last tid used. */ 290 LIST_HEAD(, lwp) p_lwps; /* List of threads in this process. */ 291 void *p_aioinfo; /* ASYNC I/O info */ 292 int p_wakeup; /* thread id XXX lwp */ 293 struct proc *p_peers; /* XXX lwp */ 294 struct proc *p_leader; /* XXX lwp */ 295 void *p_emuldata; /* process-specific emulator state */ 296 #define p_thread p_lwp.lwp_thread 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 lwp p_lwp; /* Embedded lwp XXX */ 302 struct spinlock p_spin; /* Spinlock for LWP access to proc */ 303 }; 304 305 #define p_wchan p_thread->td_wchan 306 #define p_wmesg p_thread->td_wmesg 307 #define p_session p_pgrp->pg_session 308 #define p_pgid p_pgrp->pg_id 309 310 /* 311 * Status values. Please note that p_stat doesn't actually take on 312 * synthesized states. 313 */ 314 #define SIDL 1 /* Process being created by fork. */ 315 #define SRUN 2 /* Currently runnable. */ 316 #define SSLEEP 3 /* Sleeping on an address. */ 317 #define SSTOP 4 /* Synthesized from SSLEEP + P_STOPPED */ 318 #define SZOMB 5 /* Synthesized from P_ZOMBIE for eproc only */ 319 #define STHREAD 6 /* Synthesized for eproc only */ 320 321 /* These flags are kept in p_flags. */ 322 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */ 323 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */ 324 #define P_SWAPPEDOUT 0x00004 /* Swapped out of memory */ 325 #define P_BREAKTSLEEP 0x00008 /* Event pending, break tsleep on sigcont */ 326 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */ 327 #define P_PROFIL 0x00020 /* Has started profiling. */ 328 #define P_SELECT 0x00040 /* Selecting; wakeup/waiting danger. */ 329 #define P_SINTR 0x00080 /* Sleep is interruptible. */ 330 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */ 331 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */ 332 #define P_STOPPED 0x00400 /* SIGSTOP status */ 333 #define P_TRACED 0x00800 /* Debugged process being traced. */ 334 #define P_WAITED 0x01000 /* SIGSTOP status was returned by wait3/4 */ 335 #define P_WEXIT 0x02000 /* Working on exiting. */ 336 #define P_EXEC 0x04000 /* Process called exec. */ 337 338 /* Should probably be changed into a hold count. */ 339 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */ 340 #define P_MAILBOX 0x10000 /* Possible mailbox signal pending */ 341 342 #define P_UPCALLPEND 0x20000 /* an upcall is pending */ 343 344 #define P_SWAPWAIT 0x40000 /* Waiting for a swapin */ 345 #define P_ZOMBIE 0x80000 /* Now in a zombied state */ 346 347 /* Marked a kernel thread */ 348 #define P_ONRUNQ 0x100000 /* on a user scheduling run queue */ 349 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */ 350 #define P_IDLESWAP 0x400000 /* Swapout was due to idleswap, not load */ 351 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */ 352 353 #define P_JAILED 0x1000000 /* Process is in jail */ 354 #define P_OLDMASK 0x2000000 /* need to restore mask before pause */ 355 #define P_ALTSTACK 0x4000000 /* have alternate signal stack */ 356 #define P_INEXEC 0x8000000 /* Process is in execve(). */ 357 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */ 358 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */ 359 #define P_XCPU 0x40000000 /* SIGXCPU */ 360 361 #define FIRST_LWP_IN_PROC(p) LIST_FIRST(&(p)->p_lwps) 362 #define FOREACH_LWP_IN_PROC(lp, p) \ 363 LIST_FOREACH((lp), &(p)->p_lwps, lwp_list) 364 #define ONLY_LWP_IN_PROC(p) \ 365 (p->p_nthreads != 1 && \ 366 (panic("%s: proc %p (pid %d cmd %s) has more than one thread", \ 367 __func__, p, p->p_pid, p->p_comm), 1), \ 368 FIRST_LWP_IN_PROC(p)) 369 370 /* 371 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 372 * as it is used to represent "no process group". 373 */ 374 #define PID_MAX 99999 375 #define NO_PID 100000 376 377 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p)) 378 379 #ifdef _KERNEL 380 381 #ifdef MALLOC_DECLARE 382 MALLOC_DECLARE(M_SESSION); 383 MALLOC_DECLARE(M_SUBPROC); 384 MALLOC_DECLARE(M_PARGS); 385 #endif 386 387 /* flags for suser_xxx() */ 388 #define PRISON_ROOT 0x1 389 #define NULL_CRED_OKAY 0x2 390 391 /* Handy macro to determine if p1 can mangle p2 */ 392 393 #define PRISON_CHECK(cr1, cr2) \ 394 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison) 395 396 /* 397 * STOPEVENT 398 */ 399 extern void stopevent(struct proc*, unsigned int, unsigned int); 400 #define STOPEVENT(p,e,v) \ 401 do { \ 402 if ((p)->p_stops & (e)) { \ 403 stopevent(p,e,v); \ 404 } \ 405 } while (0) 406 407 /* hold process U-area in memory, normally for ptrace/procfs work */ 408 #define PHOLD(p) (++(p)->p_lock) 409 #define PRELE(p) (--(p)->p_lock) 410 411 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash]) 412 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl; 413 extern u_long pidhash; 414 415 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash]) 416 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl; 417 extern u_long pgrphash; 418 419 #if 0 420 #ifndef SET_CURPROC 421 #define SET_CURPROC(p) (curproc = (p)) 422 #endif 423 #endif 424 425 extern struct proc proc0; /* Process 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 457 int enterpgrp (struct proc *p, pid_t pgid, int mksess); 458 void proc_add_allproc(struct proc *p); 459 void proc_move_allproc_zombie(struct proc *); 460 void proc_remove_zombie(struct proc *); 461 void allproc_scan(int (*callback)(struct proc *, void *), void *data); 462 void zombproc_scan(int (*callback)(struct proc *, void *), void *data); 463 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering); 464 void updatepcpu(struct lwp *, int, int); 465 int inferior (struct proc *p); 466 int leavepgrp (struct proc *p); 467 void sess_hold(struct session *sp); 468 void sess_rele(struct session *sp); 469 void mi_switch (struct proc *p); 470 void procinit (void); 471 void relscurproc(struct proc *curp); 472 int p_trespass (struct ucred *cr1, struct ucred *cr2); 473 void setrunnable (struct proc *); 474 void clrrunnable (struct proc *); 475 void sleep_gdinit (struct globaldata *); 476 int suser (struct thread *td); 477 int suser_cred (struct ucred *cred, int flag); 478 void cpu_heavy_switch (struct thread *); 479 void cpu_lwkt_switch (struct thread *); 480 481 void cpu_proc_exit (void) __dead2; 482 void cpu_thread_exit (void) __dead2; 483 void exit1 (int) __dead2; 484 void cpu_fork (struct lwp *, struct lwp *, int); 485 void cpu_set_fork_handler (struct lwp *, void (*)(void *), void *); 486 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg); 487 int fork1 (struct lwp *, int, struct proc **); 488 void start_forked_proc (struct lwp *, struct proc *); 489 int trace_req (struct proc *); 490 void cpu_proc_wait (struct proc *); 491 void cpu_thread_wait (struct thread *); 492 int cpu_coredump (struct thread *, struct vnode *, struct ucred *); 493 void setsugid (void); 494 void faultin (struct proc *p); 495 void swapin_request (void); 496 497 u_int32_t procrunnable (void); 498 499 #endif /* _KERNEL */ 500 501 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 502 #endif /* !_SYS_PROC_H_ */ 503