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