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