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.69 2005/10/09 21:38:04 corecode Exp $
  41  */
  42
  43 #ifndef _SYS_PROC_H_
  44 #define _SYS_PROC_H_
  45
  46 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
  47 #error "Userland must include sys/user.h instead of sys/proc.h"
  48 #endif
  49
  50 #include <sys/callout.h>                /* For struct callout_handle. */
  51 #include <sys/filedesc.h>
  52 #include <sys/queue.h>
  53 #include <sys/rtprio.h>                 /* For struct rtprio. */
  54 #include <sys/signal.h>
  55 #ifndef _KERNEL
  56 #include <sys/time.h>                   /* For structs itimerval, timeval. */
  57 #endif
  58 #include <sys/ucred.h>
  59 #include <sys/event.h>                  /* For struct klist */
  60 #include <sys/thread.h>
  61 #include <sys/varsym.h>
  62 #include <sys/upcall.h>
  63 #include <sys/resourcevar.h>
  64 #ifdef _KERNEL
  65 #include <sys/globaldata.h>
  66 #endif
  67 #include <sys/systimer.h>
  68 #include <sys/usched.h>
  69 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
  70
  71 /*
  72  * One structure allocated per session.
  73  */
  74 struct  session {
  75         int     s_count;                /* Ref cnt; pgrps in session. */
  76         struct  proc *s_leader;         /* Session leader. */
  77         struct  vnode *s_ttyvp;         /* Vnode of controlling terminal. */
  78         struct  tty *s_ttyp;            /* Controlling terminal. */
  79         pid_t   s_sid;                  /* Session ID */
  80         char    s_login[roundup(MAXLOGNAME, sizeof(long))];     /* Setlogin() name. */
  81 };
  82
  83 /*
  84  * One structure allocated per process group.
  85  */
  86 struct  pgrp {
  87         LIST_ENTRY(pgrp) pg_hash;       /* Hash chain. */
  88         LIST_HEAD(, proc) pg_members;   /* Pointer to pgrp members. */
  89         struct  session *pg_session;    /* Pointer to session. */
  90         struct  sigiolst pg_sigiolst;   /* List of sigio sources. */
  91         pid_t   pg_id;                  /* Pgrp id. */
  92         int     pg_jobc;        /* # procs qualifying pgrp for job control */
  93 };
  94
  95 struct  procsig {
  96         sigset_t ps_sigignore;  /* Signals being ignored. */
  97         sigset_t ps_sigcatch;   /* Signals being caught by user. */
  98         int      ps_flag;
  99         struct   sigacts *ps_sigacts;
 100         int      ps_refcnt;
 101 };
 102
 103 #define PS_NOCLDWAIT    0x0001  /* No zombies if child dies */
 104 #define PS_NOCLDSTOP    0x0002  /* No SIGCHLD when children stop. */
 105
 106 /*
 107  * pargs, used to hold a copy of the command line, if it had a sane
 108  * length
 109  */
 110 struct  pargs {
 111         u_int   ar_ref;         /* Reference count */
 112         u_int   ar_length;      /* Length */
 113         u_char  ar_args[0];     /* Arguments */
 114 };
 115
 116 /*
 117  * Description of a process.
 118  *
 119  * This structure contains the information needed to manage a thread of
 120  * control, known in UN*X as a process; it has references to substructures
 121  * containing descriptions of things that the process uses, but may share
 122  * with related processes.  The process structure and the substructures
 123  * are always addressable except for those marked "(PROC ONLY)" below,
 124  * which might be addressable only on a processor on which the process
 125  * is running.
 126  *
 127  * NOTE!  The process start time is stored in the thread structure associated
 128  * with the process.  If the process is a Zombie, then this field will be
 129  * inaccessible due to the thread structure being free'd in kern_wait1().
 130  */
 131
 132 struct jail;
 133
 134 struct lwp {
 135 #ifdef notyet
 136         TAILQ_ENTRY(lwp) lwp_procq;     /* run/sleep queue. */
 137 #endif
 138         LIST_ENTRY(lwp) lwp_list;       /* List of all threads in the proc. */
 139
 140         struct proc     *lwp_proc;      /* Link to our proc. */
 141
 142         int             lwp_tid;        /* Our thread id . */
 143
 144         struct pstats   *lwp_stats;     /* Accounting/statistics (PROC ONLY). */
 145 #ifdef notyet
 146         int             lwp_flag;       /* P_* flags. */
 147         char            lwp_stat;       /* S* process status. */
 148 #endif
 149
 150 #define lwp_startzero   lwp_dupfd
 151         int             lwp_dupfd;      /* Sideways return value from fdopen. XXX */
 152
 153         /*
 154          * Scheduling.
 155          */
 156         sysclock_t      lwp_cpticks;    /* cpu used in sched clock ticks */
 157         sysclock_t      lwp_cpbase;     /* Measurement base */
 158         fixpt_t         lwp_pctcpu;     /* %cpu for this process */
 159         u_int           lwp_swtime;     /* Time swapped in or out. */
 160         u_int           lwp_slptime;    /* Time since last blocked. */
 161
 162         int             lwp_traceflag;  /* Kernel trace points. */
 163
 164         union usched_data lwp_usdata;   /* User scheduler specific */
 165 #define lwp_endzero     lwp_startcopy
 166
 167 #define lwp_startcopy   lwp_siglist
 168         sigset_t        lwp_siglist;    /* Signals arrived but not delivered. */
 169         sigset_t        lwp_oldsigmask; /* saved mask from before sigpause */
 170         sigset_t        lwp_sigmask;    /* Current signal mask. */
 171         stack_t         lwp_sigstk;     /* sp & on stack state variable */
 172
 173         struct rtprio   lwp_rtprio;     /* Realtime priority. */
 174 #define lwp_endcopy     lwp_md
 175
 176 #ifdef notyet
 177         struct user     *lwp_addr;      /* XXX Really struct user? */
 178 #endif
 179         struct mdproc   lwp_md;         /* Any machine-dependent fields. */
 180
 181         struct thread   *lwp_thread;    /* backpointer to proc's thread */
 182         struct upcall   *lwp_upcall;    /* REGISTERED USERLAND POINTER! */
 183         TAILQ_HEAD(, sysmsg) lwp_sysmsgq; /* Recorded asynch system calls */
 184         int              lwp_nsysmsg;   /* Number of asynch messages running */
 185 };
 186
 187 struct  proc {
 188         TAILQ_ENTRY(proc) p_procq;      /* run/sleep queue. */
 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 #define p_stats p_lwp.lwp_stats
 196         struct plimit   *p_limit;       /* Process limits. */
 197         void            *p_pad0;
 198         struct  procsig *p_procsig;
 199 #define p_sigacts       p_procsig->ps_sigacts
 200 #define p_sigignore     p_procsig->ps_sigignore
 201 #define p_sigcatch      p_procsig->ps_sigcatch
 202 #define p_rlimit        p_limit->pl_rlimit
 203
 204         int             p_flag;         /* P_* flags. */
 205         char            p_stat;         /* S* process status. */
 206         char            p_pad1[3];
 207
 208         pid_t           p_pid;          /* Process identifier. */
 209         LIST_ENTRY(proc) p_hash;        /* Hash chain. */
 210         LIST_ENTRY(proc) p_pglist;      /* List of processes in pgrp. */
 211         struct proc     *p_pptr;        /* Pointer to parent process. */
 212         LIST_ENTRY(proc) p_sibling;     /* List of sibling processes. */
 213         LIST_HEAD(, proc) p_children;   /* Pointer to list of children. */
 214         struct callout  p_ithandle;     /* for scheduling p_realtimer */
 215         struct varsymset p_varsymset;
 216
 217 /* The following fields are all zeroed upon creation in fork. */
 218 #define p_startzero     p_oppid
 219
 220         pid_t           p_oppid;        /* Save parent pid during ptrace. XXX */
 221
 222         struct vmspace  *p_vmspace;     /* Address space. */
 223
 224 #define p_cpticks p_lwp.lwp_cpticks
 225 #define p_cpbase p_lwp.lwp_cpbase
 226 #define p_pctcpu p_lwp.lwp_pctcpu
 227 #define p_swtime p_lwp.lwp_swtime
 228 #define p_slptime p_lwp.lwp_slptime
 229
 230         struct itimerval p_realtimer;   /* Alarm timer. */
 231         struct itimerval p_timer[3];    /* Virtual-time timers. */
 232
 233         int             p_traceflag;    /* Kernel trace points. */
 234         struct vnode    *p_tracep;      /* Trace to vnode. */
 235
 236         sigset_t        p_siglist;      /* Signals arrived but not delivered. */
 237
 238         struct vnode    *p_textvp;      /* Vnode of executable. */
 239
 240 #define p_usdata p_lwp.lwp_usdata
 241
 242         unsigned int    p_stops;        /* procfs event bitmask */
 243         unsigned int    p_stype;        /* procfs stop event type */
 244         char            p_step;         /* procfs stop *once* flag */
 245         unsigned char   p_pfsflags;     /* procfs flags */
 246         char            p_pad2[2];      /* padding for alignment */
 247         struct          sigiolst p_sigiolst;    /* list of sigio sources */
 248         int             p_sigparent;    /* signal to parent on exit */
 249 #define p_oldsigmask p_lwp.lwp_oldsigmask
 250         int             p_sig;          /* for core dump/debugger XXX */
 251         u_long          p_code;         /* for core dump/debugger XXX */
 252         struct klist    p_klist;        /* knotes attached to this process */
 253
 254         struct timeval  p_start;        /* start time for a process */
 255
 256 /* End area that is zeroed on creation. */
 257 #define p_endzero       p_startcopy
 258
 259 /* The following fields are all copied upon creation in fork. */
 260 #define p_startcopy     p_comm
 261
 262 #define p_sigmask p_lwp.lwp_sigmask
 263 #define p_sigstk p_lwp.lwp_sigstk
 264
 265         char            p_comm[MAXCOMLEN+1]; /* typ 16+1 bytes */
 266         char            p_lock;         /* Process lock (prevent swap) count. */
 267         char            p_nice;         /* Process "nice" value. */
 268         char            p_pad3;
 269
 270         struct pgrp     *p_pgrp;        /* Pointer to process group. */
 271
 272         struct sysentvec *p_sysent;     /* System call dispatch information. */
 273
 274         struct uprof    p_prof;         /* Profiling arguments. */
 275         struct rtprio   p_rtprio;       /* Realtime priority. */
 276         struct pargs    *p_args;
 277 /* End area that is copied on creation. */
 278 #define p_endcopy       p_addr
 279         struct user     *p_addr;        /* Kernel virtual addr of u-area (PROC ONLY) XXX lwp */
 280 #define p_md p_lwp.lwp_md
 281
 282         u_short         p_xstat;        /* Exit status or last stop signal */
 283         u_short         p_acflag;       /* Accounting flags. */
 284         struct          rusage *p_ru;   /* Exit information. XXX */
 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 #define p_thread p_lwp.lwp_thread
 296         struct usched   *p_usched;      /* Userland scheduling control */
 297         int             p_numposixlocks; /* number of POSIX locks */
 298
 299         struct lwp      p_lwp;          /* Embedded lwp XXX */
 300 };
 301
 302 #if defined(_KERNEL)
 303 #define p_wchan         p_thread->td_wchan
 304 #define p_wmesg         p_thread->td_wmesg
 305 #define p_session       p_pgrp->pg_session
 306 #define p_pgid          p_pgrp->pg_id
 307 #endif
 308
 309 /* Status values. */
 310 #define SIDL    1               /* Process being created by fork. */
 311 #define SRUN    2               /* Currently runnable. */
 312 #define SSLEEP  3               /* Sleeping on an address. */
 313 #define SSTOP   4               /* Process debugging or suspension. */
 314 #define SZOMB   5               /* Awaiting collection by parent. */
 315 #define STHREAD 6               /* Synthesized for eproc only */
 316
 317 /* These flags are kept in p_flags. */
 318 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
 319 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
 320 #define P_INMEM         0x00004 /* Loaded into memory. */
 321 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
 322 #define P_PROFIL        0x00020 /* Has started profiling. */
 323 #define P_SELECT        0x00040 /* Selecting; wakeup/waiting danger. */
 324 #define P_SINTR         0x00080 /* Sleep is interruptible. */
 325 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
 326 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
 327 #define P_UNUSED00400   0x00400
 328 #define P_TRACED        0x00800 /* Debugged process being traced. */
 329 #define P_WAITED        0x01000 /* Debugging process has waited for child. */
 330 #define P_WEXIT         0x02000 /* Working on exiting. */
 331 #define P_EXEC          0x04000 /* Process called exec. */
 332
 333 /* Should probably be changed into a hold count. */
 334 /* was  P_NOSWAP        0x08000 was: Do not swap upages; p->p_hold */
 335 /* was  P_PHYSIO        0x10000 was: Doing physical I/O; use p->p_hold */
 336
 337 #define P_UPCALLPEND    0x20000 /* an upcall is pending */
 338
 339 #define P_SWAPPING      0x40000 /* Process is being swapped. */
 340 #define P_SWAPINREQ     0x80000 /* Swapin request due to wakeup */
 341
 342 /* Marked a kernel thread */
 343 #define P_ONRUNQ        0x100000 /* on a user scheduling run queue */
 344 #define P_KTHREADP      0x200000 /* Process is really a kernel thread */
 345 #define P_UNUSED400000  0x400000
 346 #define P_DEADLKTREAT   0x800000 /* lock aquisition - deadlock treatment */
 347
 348 #define P_JAILED        0x1000000 /* Process is in jail */
 349 #define P_OLDMASK       0x2000000 /* need to restore mask before pause */
 350 #define P_ALTSTACK      0x4000000 /* have alternate signal stack */
 351 #define P_INEXEC        0x8000000 /* Process is in execve(). */
 352 #define P_PASSIVE_ACQ   0x10000000 /* Passive acquire cpu (see kern_switch) */
 353 #define P_UPCALLWAIT    0x20000000 /* Wait for upcall or signal */
 354
 355 #ifdef _KERNEL
 356
 357 #ifdef MALLOC_DECLARE
 358 MALLOC_DECLARE(M_SESSION);
 359 MALLOC_DECLARE(M_SUBPROC);
 360 MALLOC_DECLARE(M_ZOMBIE);
 361 MALLOC_DECLARE(M_PARGS);
 362 #endif
 363
 364 /* flags for suser_xxx() */
 365 #define PRISON_ROOT     0x1
 366 #define NULL_CRED_OKAY  0x2
 367
 368 /* Handy macro to determine if p1 can mangle p2 */
 369
 370 #define PRISON_CHECK(cr1, cr2) \
 371         ((!(cr1)->cr_prison) || (cr1)->cr_prison == (cr2)->cr_prison)
 372
 373 /*
 374  * Handy macro for LISTs.
 375  */
 376 #define FOREACH_PROC_IN_SYSTEM(p)       LIST_FOREACH((p), &allproc, p_list)
 377
 378 /*
 379  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
 380  * as it is used to represent "no process group".
 381  */
 382 #define PID_MAX         99999
 383 #define NO_PID          100000
 384
 385 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
 386
 387 /*
 388  * STOPEVENT
 389  */
 390 extern void stopevent(struct proc*, unsigned int, unsigned int);
 391 #define STOPEVENT(p,e,v)                        \
 392         do {                                    \
 393                 if ((p)->p_stops & (e)) {       \
 394                         stopevent(p,e,v);       \
 395                 }                               \
 396         } while (0)
 397
 398 /* hold process U-area in memory, normally for ptrace/procfs work */
 399 #define PHOLD(p) {                                                      \
 400         if ((p)->p_lock++ == 0 && ((p)->p_flag & P_INMEM) == 0) \
 401                 faultin(p);                                             \
 402 }
 403 #define PRELE(p)        (--(p)->p_lock)
 404
 405 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
 406 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
 407 extern u_long pidhash;
 408
 409 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
 410 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
 411 extern u_long pgrphash;
 412
 413 #if 0
 414 #ifndef SET_CURPROC
 415 #define SET_CURPROC(p)  (curproc = (p))
 416 #endif
 417 #endif
 418
 419 extern struct proc proc0;               /* Process slot for swapper. */
 420 extern struct thread thread0;           /* Thread slot for swapper. */
 421 extern int hogticks;                    /* Limit on kernel cpu hogs. */
 422 extern int nprocs, maxproc;             /* Current and max number of procs. */
 423 extern int maxprocperuid;               /* Max procs per uid. */
 424 extern int sched_quantum;               /* Scheduling quantum in ticks */
 425
 426 LIST_HEAD(proclist, proc);
 427 extern struct proclist allproc;         /* List of all processes. */
 428 extern struct proclist zombproc;        /* List of zombie processes. */
 429 extern struct proc *initproc;           /* Process slot for init */
 430 extern struct thread *pagethread, *updatethread;
 431
 432 /*
 433  * Scheduler independant variables.  The primary scheduler polling frequency,
 434  * the maximum ESTCPU value, and the weighting factor for nice values.  A
 435  * cpu bound program's estcpu will increase to ESTCPUMAX - 1.
 436  */
 437 #define ESTCPUFREQ      50
 438
 439 extern  u_long ps_arg_cache_limit;
 440 extern  int ps_argsopen;
 441 extern  int ps_showallprocs;
 442
 443 struct proc *pfind (pid_t);     /* Find process by id. */
 444 struct pgrp *pgfind (pid_t);    /* Find process group by id. */
 445 struct proc *zpfind (pid_t);    /* Find zombie process by id. */
 446
 447 struct vm_zone;
 448 struct globaldata;
 449 extern struct vm_zone *proc_zone;
 450
 451 int     enterpgrp (struct proc *p, pid_t pgid, int mksess);
 452 void    fixjobc (struct proc *p, struct pgrp *pgrp, int entering);
 453 void    updatepcpu(struct proc *, int, int);
 454 int     inferior (struct proc *p);
 455 int     leavepgrp (struct proc *p);
 456 void    sess_hold(struct session *sp);
 457 void    sess_rele(struct session *sp);
 458 void    mi_switch (struct proc *p);
 459 void    procinit (void);
 460 void    relscurproc(struct proc *curp);
 461 int     p_trespass (struct ucred *cr1, struct ucred *cr2);
 462 void    setrunnable (struct proc *);
 463 void    clrrunnable (struct proc *, int stat);
 464 void    sleepinit (void);
 465 int     suser (struct thread *td);
 466 int     suser_proc (struct proc *p);
 467 int     suser_cred (struct ucred *cred, int flag);
 468 void    cpu_heavy_switch (struct thread *);
 469 void    cpu_lwkt_switch (struct thread *);
 470 void    unsleep (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 proc *, struct proc *, int);
 476 void    cpu_set_fork_handler (struct proc *, void (*)(void *), void *);
 477 void    cpu_set_thread_handler(struct thread *td, void (*retfunc)(void), void *func, void *arg);
 478 int     fork1 (struct proc *, int, struct proc **);
 479 void    start_forked_proc (struct proc *, 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
 487 u_int32_t       procrunnable (void);
 488
 489 #endif  /* _KERNEL */
 490
 491 #endif  /* !_SYS_PROC_H_ */