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