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.113 2007/08/21 19:23:04 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/tree.h> 56 #include <sys/rtprio.h> /* For struct rtprio. */ 57 #include <sys/signal.h> 58 #include <sys/lock.h> 59 #ifndef _KERNEL 60 #include <sys/time.h> /* For structs itimerval, timeval. */ 61 #endif 62 #include <sys/ucred.h> 63 #include <sys/event.h> /* For struct klist */ 64 #include <sys/thread.h> 65 #include <sys/varsym.h> 66 #include <sys/upcall.h> 67 #include <sys/resourcevar.h> 68 #ifdef _KERNEL 69 #include <sys/globaldata.h> 70 #endif 71 #include <sys/systimer.h> 72 #include <sys/usched.h> 73 #include <machine/proc.h> /* Machine-dependent proc substruct. */ 74 #include <sys/signalvar.h> 75 76 LIST_HEAD(proclist, proc); 77 LIST_HEAD(lwplist, lwp); 78 79 struct lwp_rb_tree; 80 RB_HEAD(lwp_rb_tree, lwp); 81 RB_PROTOTYPE2(lwp_rb_tree, lwp, u.lwp_rbnode, rb_lwp_compare, lwpid_t); 82 83 /* 84 * One structure allocated per session. 85 */ 86 struct session { 87 int s_count; /* Ref cnt; pgrps in session. */ 88 struct proc *s_leader; /* Session leader. */ 89 struct vnode *s_ttyvp; /* Vnode of controlling terminal. */ 90 struct tty *s_ttyp; /* Controlling terminal. */ 91 pid_t s_sid; /* Session ID */ 92 char s_login[roundup(MAXLOGNAME, sizeof(long))]; /* Setlogin() name. */ 93 }; 94 95 /* 96 * One structure allocated per process group. 97 */ 98 struct pgrp { 99 LIST_ENTRY(pgrp) pg_hash; /* Hash chain. */ 100 struct proclist pg_members; /* Pointer to pgrp members. */ 101 struct session *pg_session; /* Pointer to session. */ 102 struct sigiolst pg_sigiolst; /* List of sigio sources. */ 103 pid_t pg_id; /* Pgrp id. */ 104 int pg_jobc; /* # procs qualifying pgrp for job control */ 105 struct lock pg_lock; /* Lock during fork */ 106 }; 107 108 #define PS_NOCLDWAIT 0x0001 /* No zombies if child dies */ 109 #define PS_NOCLDSTOP 0x0002 /* No SIGCHLD when children stop. */ 110 111 /* 112 * pargs, used to hold a copy of the command line, if it had a sane 113 * length 114 */ 115 struct pargs { 116 u_int ar_ref; /* Reference count */ 117 u_int ar_length; /* Length */ 118 u_char ar_args[0]; /* Arguments */ 119 }; 120 121 /* 122 * Description of a process. 123 * 124 * This structure contains the information needed to manage a thread of 125 * control, known in UN*X as a process; it has references to substructures 126 * containing descriptions of things that the process uses, but may share 127 * with related processes. The process structure and the substructures 128 * are always addressable except for those marked "(PROC ONLY)" below, 129 * which might be addressable only on a processor on which the process 130 * is running. 131 * 132 * NOTE! The process start time is stored in the thread structure associated 133 * with the process. If the process is a Zombie, then this field will be 134 * inaccessible due to the thread structure being free'd in kern_wait1(). 135 */ 136 137 struct jail; 138 struct vkernel_proc; 139 struct vkernel_lwp; 140 struct vmspace_entry; 141 struct ktrace_node; 142 143 enum lwpstat { 144 LSRUN = 1, 145 LSSTOP = 2, 146 LSSLEEP = 3, 147 }; 148 149 enum procstat { 150 SIDL = 1, 151 SACTIVE = 2, 152 SSTOP = 3, 153 SZOMB = 4, 154 }; 155 156 struct lwp { 157 TAILQ_ENTRY(lwp) lwp_procq; /* run/sleep queue. */ 158 union { 159 RB_ENTRY(lwp) lwp_rbnode; /* RB tree node - lwp in proc */ 160 LIST_ENTRY(lwp) lwp_reap_entry; /* reaper list */ 161 } u; 162 163 struct proc *lwp_proc; /* Link to our proc. */ 164 struct vmspace *lwp_vmspace; /* Inherited from p_vmspace */ 165 struct vkernel_lwp *lwp_vkernel;/* VKernel support, lwp part */ 166 167 lwpid_t lwp_tid; /* Our thread id . */ 168 169 int lwp_flag; /* LWP_* flags. */ 170 enum lwpstat lwp_stat; /* LS* lwp status. */ 171 int lwp_lock; /* lwp lock (prevent destruct) count */ 172 173 int lwp_dupfd; /* Sideways return value from fdopen. XXX */ 174 175 /* 176 * The following two fields are marked XXX since (at least) the 177 * 4.4BSD-Lite2 import. I can only guess the reason: It is ugly. 178 * These fields are used to pass the trap code from trapsignal() to 179 * postsig(), which gets called later from userret(). 180 * 181 * The correct "fix" for these XXX is to convert our signal system 182 * to use signal queues, where each signal can carry its own meta 183 * data. 184 */ 185 int lwp_sig; /* for core dump/debugger XXX */ 186 u_long lwp_code; /* for core dump/debugger XXX */ 187 188 /* 189 * Scheduling. 190 */ 191 sysclock_t lwp_cpticks; /* cpu used in sched clock ticks */ 192 sysclock_t lwp_cpbase; /* Measurement base */ 193 fixpt_t lwp_pctcpu; /* %cpu for this process */ 194 u_int lwp_slptime; /* Time since last blocked. */ 195 196 int lwp_traceflag; /* Kernel trace points. */ 197 198 struct rusage lwp_ru; /* stats for this lwp */ 199 200 union usched_data lwp_usdata; /* User scheduler specific */ 201 202 #define lwp_startcopy lwp_cpumask 203 cpumask_t lwp_cpumask; 204 sigset_t lwp_siglist; /* Signals arrived but not delivered. */ 205 sigset_t lwp_oldsigmask; /* saved mask from before sigpause */ 206 sigset_t lwp_sigmask; /* Current signal mask. */ 207 stack_t lwp_sigstk; /* sp & on stack state variable */ 208 209 struct rtprio lwp_rtprio; /* Realtime priority. */ 210 #define lwp_endcopy lwp_md 211 212 struct mdproc lwp_md; /* Any machine-dependent fields. */ 213 214 struct thread *lwp_thread; /* backpointer to proc's thread */ 215 struct upcall *lwp_upcall; /* REGISTERED USERLAND POINTER! */ 216 }; 217 218 struct proc { 219 LIST_ENTRY(proc) p_list; /* List of all processes. */ 220 221 /* substructures: */ 222 struct ucred *p_ucred; /* Process owner's identity. */ 223 struct filedesc *p_fd; /* Ptr to open files structure. */ 224 struct filedesc_to_leader *p_fdtol; /* Ptr to tracking node XXX lwp */ 225 struct plimit *p_limit; /* Process limits. */ 226 struct pstats *p_stats; 227 void *p_pad0; 228 struct sigacts *p_sigacts; 229 #define p_sigignore p_sigacts->ps_sigignore 230 #define p_sigcatch p_sigacts->ps_sigcatch 231 #define p_rlimit p_limit->pl_rlimit 232 233 int p_flag; /* P_* flags. */ 234 enum procstat p_stat; /* S* process status. */ 235 char p_pad1[3]; 236 237 pid_t p_pid; /* Process identifier. */ 238 LIST_ENTRY(proc) p_hash; /* Hash chain. */ 239 LIST_ENTRY(proc) p_pglist; /* List of processes in pgrp. */ 240 struct proc *p_pptr; /* Pointer to parent process. */ 241 LIST_ENTRY(proc) p_sibling; /* List of sibling processes. */ 242 struct proclist p_children; /* Pointer to list of children. */ 243 struct callout p_ithandle; /* for scheduling p_realtimer */ 244 struct varsymset p_varsymset; 245 246 pid_t p_oppid; /* Save parent pid during ptrace. XXX */ 247 248 struct vmspace *p_vmspace; /* Current address space. */ 249 250 unsigned int p_swtime; /* Time swapped in or out */ 251 252 struct itimerval p_realtimer; /* Alarm timer. */ 253 struct itimerval p_timer[3]; /* Virtual-time timers. */ 254 255 int p_traceflag; /* Kernel trace points. */ 256 struct ktrace_node *p_tracenode; /* Trace to vnode. */ 257 258 sigset_t p_siglist; /* Signals arrived but not delivered. */ 259 260 struct vnode *p_textvp; /* Vnode of executable. */ 261 262 unsigned int p_stops; /* procfs event bitmask */ 263 unsigned int p_stype; /* procfs stop event type */ 264 char p_step; /* procfs stop *once* flag */ 265 unsigned char p_pfsflags; /* procfs flags */ 266 char p_pad2[2]; /* padding for alignment */ 267 struct sigiolst p_sigiolst; /* list of sigio sources */ 268 int p_sigparent; /* signal to parent on exit */ 269 struct klist p_klist; /* knotes attached to this process */ 270 271 struct timeval p_start; /* start time for a process */ 272 273 struct rusage p_ru; /* stats for this proc */ 274 struct rusage p_cru; /* sum of stats for reaped children */ 275 276 /* The following fields are all copied upon creation in fork. */ 277 #define p_startcopy p_comm 278 279 char p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */ 280 char p_lock; /* Process lock (prevent destruct) count. */ 281 char p_nice; /* Process "nice" value. */ 282 char p_pad3; 283 284 struct pgrp *p_pgrp; /* Pointer to process group. */ 285 286 struct sysentvec *p_sysent; /* System call dispatch information. */ 287 288 struct uprof p_prof; /* Profiling arguments. */ 289 struct rtprio p_rtprio; /* Realtime priority. */ 290 struct pargs *p_args; 291 /* End area that is copied on creation. */ 292 #define p_endcopy p_xstat 293 294 u_short p_xstat; /* Exit status or last stop signal */ 295 u_short p_acflag; /* Accounting flags. */ 296 297 int p_nthreads; /* Number of threads in this process. */ 298 int p_nstopped; /* Number of stopped threads. */ 299 int p_lasttid; /* Last tid used. */ 300 struct lwp_rb_tree p_lwp_tree; /* RB tree of LWPs for this process */ 301 void *p_aioinfo; /* ASYNC I/O info */ 302 int p_wakeup; /* thread id XXX lwp */ 303 struct proc *p_peers; /* XXX lwp */ 304 struct proc *p_leader; /* XXX lwp */ 305 void *p_emuldata; /* process-specific emulator state */ 306 struct usched *p_usched; /* Userland scheduling control */ 307 struct vkernel_proc *p_vkernel; /* VKernel support, proc part */ 308 int p_numposixlocks; /* number of POSIX locks */ 309 310 struct spinlock p_spin; /* Spinlock for LWP access to proc */ 311 }; 312 313 #define lwp_wchan lwp_thread->td_wchan 314 #define lwp_wmesg lwp_thread->td_wmesg 315 #define p_session p_pgrp->pg_session 316 #define p_pgid p_pgrp->pg_id 317 318 /* These flags are kept in p_flags. */ 319 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */ 320 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */ 321 #define P_SWAPPEDOUT 0x00004 /* Swapped out of memory */ 322 #define P_UNUSED3 0x00008 /* was: Event pending, break tsleep on sigcont */ 323 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */ 324 #define P_PROFIL 0x00020 /* Has started profiling. */ 325 #define P_UNUSED5 0x00040 /* was: Selecting; wakeup/waiting danger. */ 326 #define P_UNUSED4 0x00080 /* was: Sleep is interruptible. */ 327 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */ 328 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */ 329 #define P_UNUSED2 0x00400 /* was: SIGSTOP status */ 330 #define P_TRACED 0x00800 /* Debugged process being traced. */ 331 #define P_WAITED 0x01000 /* SIGSTOP status was returned by wait3/4 */ 332 #define P_WEXIT 0x02000 /* Working on exiting (master exit) */ 333 #define P_EXEC 0x04000 /* Process called exec. */ 334 335 /* Should probably be changed into a hold count. */ 336 /* was P_NOSWAP 0x08000 was: Do not swap upages; p->p_hold */ 337 #define P_MAILBOX 0x10000 /* Possible mailbox signal pending */ 338 339 #define P_UPCALLPEND 0x20000 /* an upcall is pending */ 340 341 #define P_SWAPWAIT 0x40000 /* Waiting for a swapin */ 342 #define P_UNUSED6 0x80000 /* was: Now in a zombied state */ 343 344 /* Marked a kernel thread */ 345 #define P_UNUSED07 0x100000 /* was: on a user scheduling run queue */ 346 #define P_KTHREADP 0x200000 /* Process is really a kernel thread */ 347 #define P_IDLESWAP 0x400000 /* Swapout was due to idleswap, not load */ 348 #define P_DEADLKTREAT 0x800000 /* lock aquisition - deadlock treatment */ 349 350 #define P_JAILED 0x1000000 /* Process is in jail */ 351 #define P_UNUSED0 0x2000000 /* need to restore mask before pause */ 352 #define P_UNUSED1 0x4000000 /* have alternate signal stack */ 353 #define P_INEXEC 0x8000000 /* Process is in execve(). */ 354 #define P_PASSIVE_ACQ 0x10000000 /* Passive acquire cpu (see kern_switch) */ 355 #define P_UPCALLWAIT 0x20000000 /* Wait for upcall or signal */ 356 #define P_XCPU 0x40000000 /* SIGXCPU */ 357 358 #define LWP_ALTSTACK 0x0000001 /* have alternate signal stack */ 359 #define LWP_OLDMASK 0x0000002 /* need to restore mask before pause */ 360 #define LWP_BREAKTSLEEP 0x0000004 /* Event pending, break tsleep on sigcont */ 361 #define LWP_SINTR 0x0000008 /* Sleep is interruptible. */ 362 #define LWP_SELECT 0x0000010 /* Selecting; wakeup/waiting danger. */ 363 #define LWP_ONRUNQ 0x0000020 /* on a user scheduling run queue */ 364 #define LWP_WEXIT 0x0000040 /* working on exiting */ 365 #define LWP_WSTOP 0x0000080 /* working on stopping */ 366 367 #define FIRST_LWP_IN_PROC(p) RB_FIRST(lwp_rb_tree, &(p)->p_lwp_tree) 368 #define FOREACH_LWP_IN_PROC(lp, p) \ 369 RB_FOREACH(lp, lwp_rb_tree, &(p)->p_lwp_tree) 370 #define ONLY_LWP_IN_PROC(p) \ 371 (p->p_nthreads != 1 && \ 372 (panic("%s: proc %p (pid %d cmd %s) has more than one thread", \ 373 __func__, p, p->p_pid, p->p_comm), 1), \ 374 RB_ROOT(&p->p_lwp_tree)) 375 376 /* 377 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t, 378 * as it is used to represent "no process group". 379 */ 380 #define PID_MAX 99999 381 #define NO_PID 100000 382 383 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p)) 384 385 #ifdef _KERNEL 386 387 #ifdef MALLOC_DECLARE 388 MALLOC_DECLARE(M_SESSION); 389 MALLOC_DECLARE(M_SUBPROC); 390 MALLOC_DECLARE(M_PARGS); 391 #endif 392 393 /* flags for suser_xxx() */ 394 #define PRISON_ROOT 0x1 395 #define NULL_CRED_OKAY 0x2 396 397 /* Handy macro to determine if p1 can mangle p2 */ 398 399 #define PRISON_CHECK(cr1, cr2) \ 400 ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison) 401 402 /* 403 * STOPEVENT 404 */ 405 extern void stopevent(struct proc*, unsigned int, unsigned int); 406 #define STOPEVENT(p,e,v) \ 407 do { \ 408 if ((p)->p_stops & (e)) { \ 409 stopevent(p,e,v); \ 410 } \ 411 } while (0) 412 413 /* hold process in memory, don't destruct , normally for ptrace/procfs work */ 414 #define PHOLD(p) (++(p)->p_lock) 415 #define PRELE(p) (--(p)->p_lock) 416 417 /* hold lwp in memory, don't destruct , normally for ptrace/procfs work */ 418 #define LWPHOLD(lp) (++(lp)->lwp_lock) 419 #define LWPRELE(lp) (--(lp)->lwp_lock) 420 421 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash]) 422 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl; 423 extern u_long pidhash; 424 425 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash]) 426 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl; 427 extern u_long pgrphash; 428 429 #if 0 430 #ifndef SET_CURPROC 431 #define SET_CURPROC(p) (curproc = (p)) 432 #endif 433 #endif 434 435 extern struct proc proc0; /* Process slot for swapper. */ 436 extern struct lwp lwp0; /* LWP slot for swapper. */ 437 extern struct thread thread0; /* Thread slot for swapper. */ 438 extern int hogticks; /* Limit on kernel cpu hogs. */ 439 extern int nprocs, maxproc; /* Current and max number of procs. */ 440 extern int maxprocperuid; /* Max procs per uid. */ 441 extern int sched_quantum; /* Scheduling quantum in ticks */ 442 443 extern struct proclist allproc; /* List of all processes. */ 444 extern struct proclist zombproc; /* List of zombie processes. */ 445 extern struct proc *initproc; /* Process slot for init */ 446 extern struct thread *pagethread, *updatethread; 447 448 /* 449 * Scheduler independant variables. The primary scheduler polling frequency, 450 * the maximum ESTCPU value, and the weighting factor for nice values. A 451 * cpu bound program's estcpu will increase to ESTCPUMAX - 1. 452 */ 453 #define ESTCPUFREQ 50 454 455 extern u_long ps_arg_cache_limit; 456 extern int ps_argsopen; 457 extern int ps_showallprocs; 458 459 struct proc *pfind (pid_t); /* Find process by id. */ 460 struct pgrp *pgfind (pid_t); /* Find process group by id. */ 461 struct proc *zpfind (pid_t); /* Find zombie process by id. */ 462 463 struct vm_zone; 464 struct globaldata; 465 struct lwp_params; 466 extern struct vm_zone *proc_zone; 467 extern struct vm_zone *lwp_zone; 468 469 int enterpgrp (struct proc *p, pid_t pgid, int mksess); 470 void proc_add_allproc(struct proc *p); 471 void proc_move_allproc_zombie(struct proc *); 472 void proc_remove_zombie(struct proc *); 473 void allproc_scan(int (*callback)(struct proc *, void *), void *data); 474 void alllwp_scan(int (*callback)(struct lwp *, void *), void *data); 475 void zombproc_scan(int (*callback)(struct proc *, void *), void *data); 476 void fixjobc (struct proc *p, struct pgrp *pgrp, int entering); 477 void updatepcpu(struct lwp *, int, int); 478 int inferior (struct proc *p); 479 int leavepgrp (struct proc *p); 480 void sess_hold(struct session *sp); 481 void sess_rele(struct session *sp); 482 void procinit (void); 483 void relscurproc(struct proc *curp); 484 int p_trespass (struct ucred *cr1, struct ucred *cr2); 485 void setrunnable (struct lwp *); 486 void proc_stop (struct proc *); 487 void proc_unstop (struct proc *); 488 void sleep_gdinit (struct globaldata *); 489 int suser (struct thread *td); 490 int suser_cred (struct ucred *cred, int flag); 491 void cpu_heavy_switch (struct thread *); 492 void cpu_lwkt_switch (struct thread *); 493 494 void cpu_lwp_exit (void) __dead2; 495 void cpu_thread_exit (void) __dead2; 496 void lwp_exit (int masterexit) __dead2; 497 void lwp_dispose (struct lwp *); 498 int killalllwps (int); 499 void exit1 (int) __dead2; 500 void cpu_fork (struct lwp *, struct lwp *, int); 501 int cpu_prepare_lwp(struct lwp *, struct lwp_params *); 502 void cpu_set_fork_handler (struct lwp *, void (*)(void *, struct trapframe *), void *); 503 void cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg); 504 int fork1 (struct lwp *, int, struct proc **); 505 void start_forked_proc (struct lwp *, struct proc *); 506 int trace_req (struct proc *); 507 void cpu_proc_wait (struct proc *); 508 void cpu_thread_wait (struct thread *); 509 void setsugid (void); 510 void faultin (struct proc *p); 511 void swapin_request (void); 512 513 u_int32_t procrunnable (void); 514 515 #endif /* _KERNEL */ 516 517 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 518 #endif /* !_SYS_PROC_H_ */ 519