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