usr/src/sys/sys/proc.h

/*-
 * Copyright (c) 1986, 1989, 1991, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * %sccs.include.redist.c%
 *
 *      @(#)proc.h      8.10 (Berkeley) %G%
 */

#ifndef _SYS_PROC_H_
#define _SYS_PROC_H_

#include <machine/proc.h>               /* Machine-dependent proc substruct. */
#include <sys/select.h>                 /* For struct selinfo. */
#include <sys/queue.h>

/*
 * One structure allocated per session.
 */
struct  session {
        int     s_count;                /* Ref cnt; pgrps in session. */
        struct  proc *s_leader;         /* Session leader. */
        struct  vnode *s_ttyvp;         /* Vnode of controlling terminal. */
        struct  tty *s_ttyp;            /* Controlling terminal. */
        char    s_login[MAXLOGNAME];    /* Setlogin() name. */
};

/*
 * One structure allocated per process group.
 */
struct  pgrp {
        LIST_ENTRY(pgrp) pg_hash;       /* Hash chain. */
        LIST_HEAD(, proc) pg_members;   /* Pointer to pgrp members. */
        struct  session *pg_session;    /* Pointer to session. */
        pid_t   pg_id;                  /* Pgrp id. */
        int     pg_jobc;        /* # procs qualifying pgrp for job control */
};

/*
 * Description of a process.
 *
 * This structure contains the information needed to manage a thread of
 * control, known in UN*X as a process; it has references to substructures
 * containing descriptions of things that the process uses, but may share
 * with related processes.  The process structure and the substructures
 * are always addressible except for those marked "(PROC ONLY)" below,
 * which might be addressible only on a processor on which the process
 * is running.
 */
struct  proc {
        struct  proc *p_forw;           /* Doubly-linked run/sleep queue. */
        struct  proc *p_back;
        LIST_ENTRY(proc) p_list;        /* List of all processes. */

        /* substructures: */
        struct  pcred *p_cred;          /* Process owner's identity. */
        struct  filedesc *p_fd;         /* Ptr to open files structure. */
        struct  pstats *p_stats;        /* Accounting/statistics (PROC ONLY). */
        struct  plimit *p_limit;        /* Process limits. */
        struct  vmspace *p_vmspace;     /* Address space. */
        struct  sigacts *p_sigacts;     /* Signal actions, state (PROC ONLY). */

#define p_ucred         p_cred->pc_ucred
#define p_rlimit        p_limit->pl_rlimit

        int     p_flag;                 /* P_* flags. */
        char    p_stat;                 /* S* process status. */
        char    p_pad1[3];

        pid_t   p_pid;                  /* Process identifier. */
        LIST_ENTRY(proc) p_pglist;      /* List of processes in pgrp. */
        struct  proc *p_pptr;           /* Pointer to parent process. */
        LIST_ENTRY(proc) p_sibling;     /* List of sibling processes. */
        LIST_HEAD(, proc) p_children;   /* Pointer to list of children. */

/* The following fields are all zeroed upon creation in fork. */
#define p_startzero     p_oppid

        pid_t   p_oppid;         /* Save parent pid during ptrace. XXX */
        int     p_dupfd;         /* Sideways return value from fdopen. XXX */

        /* scheduling */
        u_int   p_estcpu;        /* Time averaged value of p_cpticks. */
        int     p_cpticks;       /* Ticks of cpu time. */
        fixpt_t p_pctcpu;        /* %cpu for this process during p_swtime */
        void    *p_wchan;        /* Sleep address. */
        char    *p_wmesg;        /* Reason for sleep. */
        u_int   p_swtime;        /* Time swapped in or out. */
        u_int   p_slptime;       /* Time since last blocked. */

        struct  itimerval p_realtimer;  /* Alarm timer. */
        struct  timeval p_rtime;        /* Real time. */
        u_quad_t p_uticks;              /* Statclock hits in user mode. */
        u_quad_t p_sticks;              /* Statclock hits in system mode. */
        u_quad_t p_iticks;              /* Statclock hits processing intr. */

        int     p_traceflag;            /* Kernel trace points. */
        struct  vnode *p_tracep;        /* Trace to vnode. */

        int     p_siglist;              /* Signals arrived but not delivered. */

        struct  vnode *p_textvp;        /* Vnode of executable. */
        LIST_ENTRY(proc) p_hash;        /* Hash chain. */

        long    p_spare[3];             /* pad to 256, avoid shifting eproc. */

/* End area that is zeroed on creation. */
#define p_endzero       p_startcopy

/* The following fields are all copied upon creation in fork. */
#define p_startcopy     p_sigmask

        sigset_t p_sigmask;     /* Current signal mask. */
        sigset_t p_sigignore;   /* Signals being ignored. */
        sigset_t p_sigcatch;    /* Signals being caught by user. */

        u_char  p_priority;     /* Process priority. */
        u_char  p_usrpri;       /* User-priority based on p_cpu and p_nice. */
        char    p_nice;         /* Process "nice" value. */
        char    p_comm[MAXCOMLEN+1];

        struct  pgrp *p_pgrp;   /* Pointer to process group. */

/* End area that is copied on creation. */
#define p_endcopy       p_thread
        int     p_thread;       /* Id for this "thread"; Mach glue. XXX */
        struct  user *p_addr;   /* Kernel virtual addr of u-area (PROC ONLY). */
        struct  mdproc p_md;    /* Any machine-dependent fields. */

        u_short p_xstat;        /* Exit status for wait; also stop signal. */
        u_short p_acflag;       /* Accounting flags. */
        struct  rusage *p_ru;   /* Exit information. XXX */
};

#define p_session       p_pgrp->pg_session
#define p_pgid          p_pgrp->pg_id

/* Status values. */
#define SIDL    1               /* Process being created by fork. */
#define SRUN    2               /* Currently runnable. */
#define SSLEEP  3               /* Sleeping on an address. */
#define SSTOP   4               /* Process debugging or suspension. */
#define SZOMB   5               /* Awaiting collection by parent. */

/* These flags are kept in p_flags. */
#define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
#define P_CONTROLT      0x00002 /* Has a controlling terminal. */
#define P_INMEM         0x00004 /* Loaded into memory. */
#define P_NOCLDSTOP     0x00008 /* No SIGCHLD when children stop. */
#define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
#define P_PROFIL        0x00020 /* Has started profiling. */
#define P_SELECT        0x00040 /* Selecting; wakeup/waiting danger. */
#define P_SINTR         0x00080 /* Sleep is interruptible. */
#define P_SUGID         0x00100 /* Had set id privileges since last exec. */
#define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
#define P_TIMEOUT       0x00400 /* Timing out during sleep. */
#define P_TRACED        0x00800 /* Debugged process being traced. */
#define P_WAITED        0x01000 /* Debugging process has waited for child. */
#define P_WEXIT         0x02000 /* Working on exiting. */
#define P_EXEC          0x04000 /* Process called exec. */

/* Should probably be changed into a hold count. */
#define P_NOSWAP        0x08000 /* Another flag to prevent swap out. */
#define P_PHYSIO        0x10000 /* Doing physical I/O. */

/* Should be moved to machine-dependent areas. */
#define P_OWEUPC        0x20000 /* Owe process an addupc() call at next ast. */

/*
 * MOVE TO ucred.h?
 *
 * Shareable process credentials (always resident).  This includes a reference
 * to the current user credentials as well as real and saved ids that may be
 * used to change ids.
 */
struct  pcred {
        struct  ucred *pc_ucred;        /* Current credentials. */
        uid_t   p_ruid;                 /* Real user id. */
        uid_t   p_svuid;                /* Saved effective user id. */
        gid_t   p_rgid;                 /* Real group id. */
        gid_t   p_svgid;                /* Saved effective group id. */
        int     p_refcnt;               /* Number of references. */
};

#ifdef KERNEL
/*
 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
 * as it is used to represent "no process group".
 */
#define PID_MAX         30000
#define NO_PID          30001

#define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
#define SESSHOLD(s)     ((s)->s_count++)
#define SESSRELE(s) {                                                   \
        if (--(s)->s_count == 0)                                        \
                FREE(s, M_SESSION);                                     \
}

#define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
extern u_long pidhash;

#define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
extern u_long pgrphash;

extern struct proc *curproc;            /* Current running proc. */
extern struct proc proc0;               /* Process slot for swapper. */
extern int nprocs, maxproc;             /* Current and max number of procs. */
extern int pidhashmask;                 /* In param.c. */

extern LIST_HEAD(, proc) allproc;       /* List of all processes. */
extern LIST_HEAD(, proc) zombproc;      /* List of zombie processes. */
struct proc *initproc, *pageproc;       /* Process slots for init, pager. */

#define NQS     32                      /* 32 run queues. */
int     whichqs;                        /* Bit mask summary of non-empty Q's. */
struct  prochd {
        struct  proc *ph_link;          /* Linked list of running processes. */
        struct  proc *ph_rlink;
} qs[NQS];

struct proc *pfind __P((pid_t));        /* Find process by id. */
struct pgrp *pgfind __P((pid_t));       /* Find process group by id. */

void    mi_switch __P((void));
void    resetpriority __P((struct proc *));
void    setrunnable __P((struct proc *));
void    setrunqueue __P((struct proc *));
void    sleep __P((void *chan, int pri));
int     tsleep __P((void *chan, int pri, char *wmesg, int timo));
void    unsleep __P((struct proc *));
void    wakeup __P((void *chan));
#endif  /* KERNEL */
#endif  /* !_SYS_PROC_H_ */