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