The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/proc.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-3-Clause
    3  *
    4  * Copyright (c) 1986, 1989, 1991, 1993
    5  *      The Regents of the University of California.  All rights reserved.
    6  * (c) UNIX System Laboratories, Inc.
    7  * All or some portions of this file are derived from material licensed
    8  * to the University of California by American Telephone and Telegraph
    9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   10  * the permission of UNIX System Laboratories, Inc.
   11  *
   12  * Redistribution and use in source and binary forms, with or without
   13  * modification, are permitted provided that the following conditions
   14  * are met:
   15  * 1. Redistributions of source code must retain the above copyright
   16  *    notice, this list of conditions and the following disclaimer.
   17  * 2. Redistributions in binary form must reproduce the above copyright
   18  *    notice, this list of conditions and the following disclaimer in the
   19  *    documentation and/or other materials provided with the distribution.
   20  * 3. Neither the name of the University nor the names of its contributors
   21  *    may be used to endorse or promote products derived from this software
   22  *    without specific prior written permission.
   23  *
   24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   34  * SUCH DAMAGE.
   35  *
   36  *      @(#)proc.h      8.15 (Berkeley) 5/19/95
   37  * $FreeBSD: stable/12/sys/sys/proc.h 345446 2019-03-23 11:47:13Z kib $
   38  */
   39 
   40 #ifndef _SYS_PROC_H_
   41 #define _SYS_PROC_H_
   42 
   43 #include <sys/callout.h>                /* For struct callout. */
   44 #include <sys/event.h>                  /* For struct klist. */
   45 #include <sys/condvar.h>
   46 #ifndef _KERNEL
   47 #include <sys/filedesc.h>
   48 #endif
   49 #include <sys/queue.h>
   50 #include <sys/_lock.h>
   51 #include <sys/lock_profile.h>
   52 #include <sys/_mutex.h>
   53 #include <sys/osd.h>
   54 #include <sys/priority.h>
   55 #include <sys/rtprio.h>                 /* XXX. */
   56 #include <sys/runq.h>
   57 #include <sys/resource.h>
   58 #include <sys/sigio.h>
   59 #include <sys/signal.h>
   60 #include <sys/signalvar.h>
   61 #ifndef _KERNEL
   62 #include <sys/time.h>                   /* For structs itimerval, timeval. */
   63 #else
   64 #include <sys/pcpu.h>
   65 #include <sys/systm.h>
   66 #endif
   67 #include <sys/ucontext.h>
   68 #include <sys/ucred.h>
   69 #include <sys/types.h>
   70 #include <sys/_domainset.h>
   71 
   72 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
   73 #ifdef _KERNEL
   74 #include <machine/cpu.h>
   75 #endif
   76 
   77 /*
   78  * One structure allocated per session.
   79  *
   80  * List of locks
   81  * (m)          locked by s_mtx mtx
   82  * (e)          locked by proctree_lock sx
   83  * (c)          const until freeing
   84  */
   85 struct session {
   86         u_int           s_count;        /* Ref cnt; pgrps in session - atomic. */
   87         struct proc     *s_leader;      /* (m + e) Session leader. */
   88         struct vnode    *s_ttyvp;       /* (m) Vnode of controlling tty. */
   89         struct cdev_priv *s_ttydp;      /* (m) Device of controlling tty.  */
   90         struct tty      *s_ttyp;        /* (e) Controlling tty. */
   91         pid_t           s_sid;          /* (c) Session ID. */
   92                                         /* (m) Setlogin() name: */
   93         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
   94         struct mtx      s_mtx;          /* Mutex to protect members. */
   95 };
   96 
   97 /*
   98  * One structure allocated per process group.
   99  *
  100  * List of locks
  101  * (m)          locked by pg_mtx mtx
  102  * (e)          locked by proctree_lock sx
  103  * (c)          const until freeing
  104  */
  105 struct pgrp {
  106         LIST_ENTRY(pgrp) pg_hash;       /* (e) Hash chain. */
  107         LIST_HEAD(, proc) pg_members;   /* (m + e) Pointer to pgrp members. */
  108         struct session  *pg_session;    /* (c) Pointer to session. */
  109         struct sigiolst pg_sigiolst;    /* (m) List of sigio sources. */
  110         pid_t           pg_id;          /* (c) Process group id. */
  111         int             pg_jobc;        /* (m) Job control process count. */
  112         struct mtx      pg_mtx;         /* Mutex to protect members */
  113 };
  114 
  115 /*
  116  * pargs, used to hold a copy of the command line, if it had a sane length.
  117  */
  118 struct pargs {
  119         u_int   ar_ref;         /* Reference count. */
  120         u_int   ar_length;      /* Length. */
  121         u_char  ar_args[1];     /* Arguments. */
  122 };
  123 
  124 /*-
  125  * Description of a process.
  126  *
  127  * This structure contains the information needed to manage a thread of
  128  * control, known in UN*X as a process; it has references to substructures
  129  * containing descriptions of things that the process uses, but may share
  130  * with related processes.  The process structure and the substructures
  131  * are always addressable except for those marked "(CPU)" below,
  132  * which might be addressable only on a processor on which the process
  133  * is running.
  134  *
  135  * Below is a key of locks used to protect each member of struct proc.  The
  136  * lock is indicated by a reference to a specific character in parens in the
  137  * associated comment.
  138  *      * - not yet protected
  139  *      a - only touched by curproc or parent during fork/wait
  140  *      b - created at fork, never changes
  141  *              (exception aiods switch vmspaces, but they are also
  142  *              marked 'P_SYSTEM' so hopefully it will be left alone)
  143  *      c - locked by proc mtx
  144  *      d - locked by allproc_lock lock
  145  *      e - locked by proctree_lock lock
  146  *      f - session mtx
  147  *      g - process group mtx
  148  *      h - callout_lock mtx
  149  *      i - by curproc or the master session mtx
  150  *      j - locked by proc slock
  151  *      k - only accessed by curthread
  152  *      k*- only accessed by curthread and from an interrupt
  153  *      kx- only accessed by curthread and by debugger
  154  *      l - the attaching proc or attaching proc parent
  155  *      m - Giant
  156  *      n - not locked, lazy
  157  *      o - ktrace lock
  158  *      q - td_contested lock
  159  *      r - p_peers lock
  160  *      s - see sleepq_switch(), sleeping_on_old_rtc(), and sleep(9)
  161  *      t - thread lock
  162  *      u - process stat lock
  163  *      w - process timer lock
  164  *      x - created at fork, only changes during single threading in exec
  165  *      y - created at first aio, doesn't change until exit or exec at which
  166  *          point we are single-threaded and only curthread changes it
  167  *      z - zombie threads lock
  168  *
  169  * If the locking key specifies two identifiers (for example, p_pptr) then
  170  * either lock is sufficient for read access, but both locks must be held
  171  * for write access.
  172  */
  173 struct cpuset;
  174 struct filecaps;
  175 struct filemon;
  176 struct kaioinfo;
  177 struct kaudit_record;
  178 struct kdtrace_proc;
  179 struct kdtrace_thread;
  180 struct mqueue_notifier;
  181 struct nlminfo;
  182 struct p_sched;
  183 struct proc;
  184 struct procdesc;
  185 struct racct;
  186 struct sbuf;
  187 struct sleepqueue;
  188 struct socket;
  189 struct syscall_args;
  190 struct td_sched;
  191 struct thread;
  192 struct trapframe;
  193 struct turnstile;
  194 struct vm_map;
  195 struct vm_map_entry;
  196 
  197 /*
  198  * XXX: Does this belong in resource.h or resourcevar.h instead?
  199  * Resource usage extension.  The times in rusage structs in the kernel are
  200  * never up to date.  The actual times are kept as runtimes and tick counts
  201  * (with control info in the "previous" times), and are converted when
  202  * userland asks for rusage info.  Backwards compatibility prevents putting
  203  * this directly in the user-visible rusage struct.
  204  *
  205  * Locking for p_rux: (cu) means (u) for p_rux and (c) for p_crux.
  206  * Locking for td_rux: (t) for all fields.
  207  */
  208 struct rusage_ext {
  209         uint64_t        rux_runtime;    /* (cu) Real time. */
  210         uint64_t        rux_uticks;     /* (cu) Statclock hits in user mode. */
  211         uint64_t        rux_sticks;     /* (cu) Statclock hits in sys mode. */
  212         uint64_t        rux_iticks;     /* (cu) Statclock hits in intr mode. */
  213         uint64_t        rux_uu;         /* (c) Previous user time in usec. */
  214         uint64_t        rux_su;         /* (c) Previous sys time in usec. */
  215         uint64_t        rux_tu;         /* (c) Previous total time in usec. */
  216 };
  217 
  218 /*
  219  * Kernel runnable context (thread).
  220  * This is what is put to sleep and reactivated.
  221  * Thread context.  Processes may have multiple threads.
  222  */
  223 struct thread {
  224         struct mtx      *volatile td_lock; /* replaces sched lock */
  225         struct proc     *td_proc;       /* (*) Associated process. */
  226         TAILQ_ENTRY(thread) td_plist;   /* (*) All threads in this proc. */
  227         TAILQ_ENTRY(thread) td_runq;    /* (t) Run queue. */
  228         TAILQ_ENTRY(thread) td_slpq;    /* (t) Sleep queue. */
  229         TAILQ_ENTRY(thread) td_lockq;   /* (t) Lock queue. */
  230         LIST_ENTRY(thread) td_hash;     /* (d) Hash chain. */
  231         struct cpuset   *td_cpuset;     /* (t) CPU affinity mask. */
  232         struct domainset_ref td_domain; /* (a) NUMA policy */
  233         struct seltd    *td_sel;        /* Select queue/channel. */
  234         struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
  235         struct turnstile *td_turnstile; /* (k) Associated turnstile. */
  236         struct rl_q_entry *td_rlqe;     /* (k) Associated range lock entry. */
  237         struct umtx_q   *td_umtxq;      /* (c?) Link for when we're blocked. */
  238         lwpid_t         td_tid;         /* (b) Thread ID. */
  239         sigqueue_t      td_sigqueue;    /* (c) Sigs arrived, not delivered. */
  240 #define td_siglist      td_sigqueue.sq_signals
  241         u_char          td_lend_user_pri; /* (t) Lend user pri. */
  242 
  243 /* Cleared during fork1() */
  244 #define td_startzero td_epochnest
  245         u_char          td_epochnest;   /* (k) Epoch nest counter. */
  246         int             td_flags;       /* (t) TDF_* flags. */
  247         int             td_inhibitors;  /* (t) Why can not run. */
  248         int             td_pflags;      /* (k) Private thread (TDP_*) flags. */
  249         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
  250         int             td_sqqueue;     /* (t) Sleepqueue queue blocked on. */
  251         void            *td_wchan;      /* (t) Sleep address. */
  252         const char      *td_wmesg;      /* (t) Reason for sleep. */
  253         volatile u_char td_owepreempt;  /* (k*) Preempt on last critical_exit */
  254         u_char          td_tsqueue;     /* (t) Turnstile queue blocked on. */
  255         short           td_locks;       /* (k) Debug: count of non-spin locks */
  256         short           td_rw_rlocks;   /* (k) Count of rwlock read locks. */
  257         short           td_sx_slocks;   /* (k) Count of sx shared locks. */
  258         short           td_lk_slocks;   /* (k) Count of lockmgr shared locks. */
  259         short           td_stopsched;   /* (k) Scheduler stopped. */
  260         struct turnstile *td_blocked;   /* (t) Lock thread is blocked on. */
  261         const char      *td_lockname;   /* (t) Name of lock blocked on. */
  262         LIST_HEAD(, turnstile) td_contested;    /* (q) Contested locks. */
  263         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
  264         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
  265         int             td_pinned;      /* (k) Temporary cpu pin count. */
  266         struct ucred    *td_ucred;      /* (k) Reference to credentials. */
  267         struct plimit   *td_limit;      /* (k) Resource limits. */
  268         int             td_slptick;     /* (t) Time at sleep. */
  269         int             td_blktick;     /* (t) Time spent blocked. */
  270         int             td_swvoltick;   /* (t) Time at last SW_VOL switch. */
  271         int             td_swinvoltick; /* (t) Time at last SW_INVOL switch. */
  272         u_int           td_cow;         /* (*) Number of copy-on-write faults */
  273         struct rusage   td_ru;          /* (t) rusage information. */
  274         struct rusage_ext td_rux;       /* (t) Internal rusage information. */
  275         uint64_t        td_incruntime;  /* (t) Cpu ticks to transfer to proc. */
  276         uint64_t        td_runtime;     /* (t) How many cpu ticks we've run. */
  277         u_int           td_pticks;      /* (t) Statclock hits for profiling */
  278         u_int           td_sticks;      /* (t) Statclock hits in system mode. */
  279         u_int           td_iticks;      /* (t) Statclock hits in intr mode. */
  280         u_int           td_uticks;      /* (t) Statclock hits in user mode. */
  281         int             td_intrval;     /* (t) Return value for sleepq. */
  282         sigset_t        td_oldsigmask;  /* (k) Saved mask from pre sigpause. */
  283         volatile u_int  td_generation;  /* (k) For detection of preemption */
  284         stack_t         td_sigstk;      /* (k) Stack ptr and on-stack flag. */
  285         int             td_xsig;        /* (c) Signal for ptrace */
  286         u_long          td_profil_addr; /* (k) Temporary addr until AST. */
  287         u_int           td_profil_ticks; /* (k) Temporary ticks until AST. */
  288         char            td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
  289         struct file     *td_fpop;       /* (k) file referencing cdev under op */
  290         int             td_dbgflags;    /* (c) Userland debugger flags */
  291         siginfo_t       td_si;          /* (c) For debugger or core file */
  292         int             td_ng_outbound; /* (k) Thread entered ng from above. */
  293         struct osd      td_osd;         /* (k) Object specific data. */
  294         struct vm_map_entry *td_map_def_user; /* (k) Deferred entries. */
  295         pid_t           td_dbg_forked;  /* (c) Child pid for debugger. */
  296         u_int           td_vp_reserv;   /* (k) Count of reserved vnodes. */
  297         int             td_no_sleeping; /* (k) Sleeping disabled count. */
  298         void            *td_su;         /* (k) FFS SU private */
  299         sbintime_t      td_sleeptimo;   /* (t) Sleep timeout. */
  300         int             td_rtcgen;      /* (s) rtc_generation of abs. sleep */
  301         size_t          td_vslock_sz;   /* (k) amount of vslock-ed space */
  302 #define td_endzero td_sigmask
  303 
  304 /* Copied during fork1() or create_thread(). */
  305 #define td_startcopy td_endzero
  306         sigset_t        td_sigmask;     /* (c) Current signal mask. */
  307         u_char          td_rqindex;     /* (t) Run queue index. */
  308         u_char          td_base_pri;    /* (t) Thread base kernel priority. */
  309         u_char          td_priority;    /* (t) Thread active priority. */
  310         u_char          td_pri_class;   /* (t) Scheduling class. */
  311         u_char          td_user_pri;    /* (t) User pri from estcpu and nice. */
  312         u_char          td_base_user_pri; /* (t) Base user pri */
  313         u_char          td_pre_epoch_prio; /* (k) User pri on entry to epoch */
  314         uintptr_t       td_rb_list;     /* (k) Robust list head. */
  315         uintptr_t       td_rbp_list;    /* (k) Robust priv list head. */
  316         uintptr_t       td_rb_inact;    /* (k) Current in-action mutex loc. */
  317         struct syscall_args td_sa;      /* (kx) Syscall parameters. Copied on
  318                                            fork for child tracing. */
  319 #define td_endcopy td_pcb
  320 
  321 /*
  322  * Fields that must be manually set in fork1() or create_thread()
  323  * or already have been set in the allocator, constructor, etc.
  324  */
  325         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
  326         enum {
  327                 TDS_INACTIVE = 0x0,
  328                 TDS_INHIBITED,
  329                 TDS_CAN_RUN,
  330                 TDS_RUNQ,
  331                 TDS_RUNNING
  332         } td_state;                     /* (t) thread state */
  333         union {
  334                 register_t      tdu_retval[2];
  335                 off_t           tdu_off;
  336         } td_uretoff;                   /* (k) Syscall aux returns. */
  337 #define td_retval       td_uretoff.tdu_retval
  338         u_int           td_cowgen;      /* (k) Generation of COW pointers. */
  339         /* LP64 hole */
  340         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
  341         struct trapframe *td_frame;     /* (k) */
  342         struct vm_object *td_kstack_obj;/* (a) Kstack object. */
  343         vm_offset_t     td_kstack;      /* (a) Kernel VA of kstack. */
  344         int             td_kstack_pages; /* (a) Size of the kstack. */
  345         volatile u_int  td_critnest;    /* (k*) Critical section nest level. */
  346         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
  347         struct kaudit_record    *td_ar; /* (k) Active audit record, if any. */
  348         struct lpohead  td_lprof[2];    /* (a) lock profiling objects. */
  349         struct kdtrace_thread   *td_dtrace; /* (*) DTrace-specific data. */
  350         int             td_errno;       /* Error returned by last syscall. */
  351         /* LP64 hole */
  352         struct vnet     *td_vnet;       /* (k) Effective vnet. */
  353         const char      *td_vnet_lpush; /* (k) Debugging vnet push / pop. */
  354         struct trapframe *td_intr_frame;/* (k) Frame of the current irq */
  355         struct proc     *td_rfppwait_p; /* (k) The vforked child */
  356         struct vm_page  **td_ma;        /* (k) uio pages held */
  357         int             td_ma_cnt;      /* (k) size of *td_ma */
  358         /* LP64 hole */
  359         void            *td_emuldata;   /* Emulator state data */
  360         int             td_lastcpu;     /* (t) Last cpu we were on. */
  361         int             td_oncpu;       /* (t) Which cpu we are on. */
  362         void            *td_lkpi_task;  /* LinuxKPI task struct pointer */
  363         int             td_pmcpend;
  364 };
  365 
  366 struct thread0_storage {
  367         struct thread t0st_thread;
  368         uint64_t t0st_sched[10];
  369 };
  370 
  371 struct mtx *thread_lock_block(struct thread *);
  372 void thread_lock_unblock(struct thread *, struct mtx *);
  373 void thread_lock_set(struct thread *, struct mtx *);
  374 #define THREAD_LOCK_ASSERT(td, type)                                    \
  375 do {                                                                    \
  376         struct mtx *__m = (td)->td_lock;                                \
  377         if (__m != &blocked_lock)                                       \
  378                 mtx_assert(__m, (type));                                \
  379 } while (0)
  380 
  381 #ifdef INVARIANTS
  382 #define THREAD_LOCKPTR_ASSERT(td, lock)                                 \
  383 do {                                                                    \
  384         struct mtx *__m = (td)->td_lock;                                \
  385         KASSERT((__m == &blocked_lock || __m == (lock)),                \
  386             ("Thread %p lock %p does not match %p", td, __m, (lock)));  \
  387 } while (0)
  388 
  389 #define TD_LOCKS_INC(td)        ((td)->td_locks++)
  390 #define TD_LOCKS_DEC(td) do {                                           \
  391         KASSERT(SCHEDULER_STOPPED_TD(td) || (td)->td_locks > 0,         \
  392             ("thread %p owns no locks", (td)));                         \
  393         (td)->td_locks--;                                               \
  394 } while (0)
  395 #else
  396 #define THREAD_LOCKPTR_ASSERT(td, lock)
  397 
  398 #define TD_LOCKS_INC(td)
  399 #define TD_LOCKS_DEC(td)
  400 #endif
  401 
  402 /*
  403  * Flags kept in td_flags:
  404  * To change these you MUST have the scheduler lock.
  405  */
  406 #define TDF_BORROWING   0x00000001 /* Thread is borrowing pri from another. */
  407 #define TDF_INPANIC     0x00000002 /* Caused a panic, let it drive crashdump. */
  408 #define TDF_INMEM       0x00000004 /* Thread's stack is in memory. */
  409 #define TDF_SINTR       0x00000008 /* Sleep is interruptible. */
  410 #define TDF_TIMEOUT     0x00000010 /* Timing out during sleep. */
  411 #define TDF_IDLETD      0x00000020 /* This is a per-CPU idle thread. */
  412 #define TDF_CANSWAP     0x00000040 /* Thread can be swapped. */
  413 #define TDF_SLEEPABORT  0x00000080 /* sleepq_abort was called. */
  414 #define TDF_KTH_SUSP    0x00000100 /* kthread is suspended */
  415 #define TDF_ALLPROCSUSP 0x00000200 /* suspended by SINGLE_ALLPROC */
  416 #define TDF_BOUNDARY    0x00000400 /* Thread suspended at user boundary */
  417 #define TDF_ASTPENDING  0x00000800 /* Thread has some asynchronous events. */
  418 #define TDF_UNUSED12    0x00001000 /* --available-- */
  419 #define TDF_SBDRY       0x00002000 /* Stop only on usermode boundary. */
  420 #define TDF_UPIBLOCKED  0x00004000 /* Thread blocked on user PI mutex. */
  421 #define TDF_NEEDSUSPCHK 0x00008000 /* Thread may need to suspend. */
  422 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
  423 #define TDF_NEEDSIGCHK  0x00020000 /* Thread may need signal delivery. */
  424 #define TDF_NOLOAD      0x00040000 /* Ignore during load avg calculations. */
  425 #define TDF_SERESTART   0x00080000 /* ERESTART on stop attempts. */
  426 #define TDF_THRWAKEUP   0x00100000 /* Libthr thread must not suspend itself. */
  427 #define TDF_SEINTR      0x00200000 /* EINTR on stop attempts. */
  428 #define TDF_SWAPINREQ   0x00400000 /* Swapin request due to wakeup. */
  429 #define TDF_UNUSED23    0x00800000 /* --available-- */
  430 #define TDF_SCHED0      0x01000000 /* Reserved for scheduler private use */
  431 #define TDF_SCHED1      0x02000000 /* Reserved for scheduler private use */
  432 #define TDF_SCHED2      0x04000000 /* Reserved for scheduler private use */
  433 #define TDF_SCHED3      0x08000000 /* Reserved for scheduler private use */
  434 #define TDF_ALRMPEND    0x10000000 /* Pending SIGVTALRM needs to be posted. */
  435 #define TDF_PROFPEND    0x20000000 /* Pending SIGPROF needs to be posted. */
  436 #define TDF_MACPEND     0x40000000 /* AST-based MAC event pending. */
  437 
  438 /* Userland debug flags */
  439 #define TDB_SUSPEND     0x00000001 /* Thread is suspended by debugger */
  440 #define TDB_XSIG        0x00000002 /* Thread is exchanging signal under trace */
  441 #define TDB_USERWR      0x00000004 /* Debugger modified memory or registers */
  442 #define TDB_SCE         0x00000008 /* Thread performs syscall enter */
  443 #define TDB_SCX         0x00000010 /* Thread performs syscall exit */
  444 #define TDB_EXEC        0x00000020 /* TDB_SCX from exec(2) family */
  445 #define TDB_FORK        0x00000040 /* TDB_SCX from fork(2) that created new
  446                                       process */
  447 #define TDB_STOPATFORK  0x00000080 /* Stop at the return from fork (child
  448                                       only) */
  449 #define TDB_CHILD       0x00000100 /* New child indicator for ptrace() */
  450 #define TDB_BORN        0x00000200 /* New LWP indicator for ptrace() */
  451 #define TDB_EXIT        0x00000400 /* Exiting LWP indicator for ptrace() */
  452 #define TDB_VFORK       0x00000800 /* vfork indicator for ptrace() */
  453 #define TDB_FSTP        0x00001000 /* The thread is PT_ATTACH leader */
  454 #define TDB_STEP        0x00002000 /* (x86) PSL_T set for PT_STEP */
  455 
  456 /*
  457  * "Private" flags kept in td_pflags:
  458  * These are only written by curthread and thus need no locking.
  459  */
  460 #define TDP_OLDMASK     0x00000001 /* Need to restore mask after suspend. */
  461 #define TDP_INKTR       0x00000002 /* Thread is currently in KTR code. */
  462 #define TDP_INKTRACE    0x00000004 /* Thread is currently in KTRACE code. */
  463 #define TDP_BUFNEED     0x00000008 /* Do not recurse into the buf flush */
  464 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
  465 #define TDP_ALTSTACK    0x00000020 /* Have alternate signal stack. */
  466 #define TDP_DEADLKTREAT 0x00000040 /* Lock acquisition - deadlock treatment. */
  467 #define TDP_NOFAULTING  0x00000080 /* Do not handle page faults. */
  468 #define TDP_UNUSED9     0x00000100 /* --available-- */
  469 #define TDP_OWEUPC      0x00000200 /* Call addupc() at next AST. */
  470 #define TDP_ITHREAD     0x00000400 /* Thread is an interrupt thread. */
  471 #define TDP_SYNCIO      0x00000800 /* Local override, disable async i/o. */
  472 #define TDP_SCHED1      0x00001000 /* Reserved for scheduler private use */
  473 #define TDP_SCHED2      0x00002000 /* Reserved for scheduler private use */
  474 #define TDP_SCHED3      0x00004000 /* Reserved for scheduler private use */
  475 #define TDP_SCHED4      0x00008000 /* Reserved for scheduler private use */
  476 #define TDP_GEOM        0x00010000 /* Settle GEOM before finishing syscall */
  477 #define TDP_SOFTDEP     0x00020000 /* Stuck processing softdep worklist */
  478 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
  479 #define TDP_WAKEUP      0x00080000 /* Don't sleep in umtx cond_wait */
  480 #define TDP_INBDFLUSH   0x00100000 /* Already in BO_BDFLUSH, do not recurse */
  481 #define TDP_KTHREAD     0x00200000 /* This is an official kernel thread */
  482 #define TDP_CALLCHAIN   0x00400000 /* Capture thread's callchain */
  483 #define TDP_IGNSUSP     0x00800000 /* Permission to ignore the MNTK_SUSPEND* */
  484 #define TDP_AUDITREC    0x01000000 /* Audit record pending on thread */
  485 #define TDP_RFPPWAIT    0x02000000 /* Handle RFPPWAIT on syscall exit */
  486 #define TDP_RESETSPUR   0x04000000 /* Reset spurious page fault history. */
  487 #define TDP_NERRNO      0x08000000 /* Last errno is already in td_errno */
  488 #define TDP_UIOHELD     0x10000000 /* Current uio has pages held in td_ma */
  489 #define TDP_FORKING     0x20000000 /* Thread is being created through fork() */
  490 #define TDP_EXECVMSPC   0x40000000 /* Execve destroyed old vmspace */
  491 
  492 /*
  493  * Reasons that the current thread can not be run yet.
  494  * More than one may apply.
  495  */
  496 #define TDI_SUSPENDED   0x0001  /* On suspension queue. */
  497 #define TDI_SLEEPING    0x0002  /* Actually asleep! (tricky). */
  498 #define TDI_SWAPPED     0x0004  /* Stack not in mem.  Bad juju if run. */
  499 #define TDI_LOCK        0x0008  /* Stopped on a lock. */
  500 #define TDI_IWAIT       0x0010  /* Awaiting interrupt. */
  501 
  502 #define TD_IS_SLEEPING(td)      ((td)->td_inhibitors & TDI_SLEEPING)
  503 #define TD_ON_SLEEPQ(td)        ((td)->td_wchan != NULL)
  504 #define TD_IS_SUSPENDED(td)     ((td)->td_inhibitors & TDI_SUSPENDED)
  505 #define TD_IS_SWAPPED(td)       ((td)->td_inhibitors & TDI_SWAPPED)
  506 #define TD_ON_LOCK(td)          ((td)->td_inhibitors & TDI_LOCK)
  507 #define TD_AWAITING_INTR(td)    ((td)->td_inhibitors & TDI_IWAIT)
  508 #define TD_IS_RUNNING(td)       ((td)->td_state == TDS_RUNNING)
  509 #define TD_ON_RUNQ(td)          ((td)->td_state == TDS_RUNQ)
  510 #define TD_CAN_RUN(td)          ((td)->td_state == TDS_CAN_RUN)
  511 #define TD_IS_INHIBITED(td)     ((td)->td_state == TDS_INHIBITED)
  512 #define TD_ON_UPILOCK(td)       ((td)->td_flags & TDF_UPIBLOCKED)
  513 #define TD_IS_IDLETHREAD(td)    ((td)->td_flags & TDF_IDLETD)
  514 
  515 #define KTDSTATE(td)                                                    \
  516         (((td)->td_inhibitors & TDI_SLEEPING) != 0 ? "sleep"  :         \
  517         ((td)->td_inhibitors & TDI_SUSPENDED) != 0 ? "suspended" :      \
  518         ((td)->td_inhibitors & TDI_SWAPPED) != 0 ? "swapped" :          \
  519         ((td)->td_inhibitors & TDI_LOCK) != 0 ? "blocked" :             \
  520         ((td)->td_inhibitors & TDI_IWAIT) != 0 ? "iwait" : "yielding")
  521 
  522 #define TD_SET_INHIB(td, inhib) do {                    \
  523         (td)->td_state = TDS_INHIBITED;                 \
  524         (td)->td_inhibitors |= (inhib);                 \
  525 } while (0)
  526 
  527 #define TD_CLR_INHIB(td, inhib) do {                    \
  528         if (((td)->td_inhibitors & (inhib)) &&          \
  529             (((td)->td_inhibitors &= ~(inhib)) == 0))   \
  530                 (td)->td_state = TDS_CAN_RUN;           \
  531 } while (0)
  532 
  533 #define TD_SET_SLEEPING(td)     TD_SET_INHIB((td), TDI_SLEEPING)
  534 #define TD_SET_SWAPPED(td)      TD_SET_INHIB((td), TDI_SWAPPED)
  535 #define TD_SET_LOCK(td)         TD_SET_INHIB((td), TDI_LOCK)
  536 #define TD_SET_SUSPENDED(td)    TD_SET_INHIB((td), TDI_SUSPENDED)
  537 #define TD_SET_IWAIT(td)        TD_SET_INHIB((td), TDI_IWAIT)
  538 #define TD_SET_EXITING(td)      TD_SET_INHIB((td), TDI_EXITING)
  539 
  540 #define TD_CLR_SLEEPING(td)     TD_CLR_INHIB((td), TDI_SLEEPING)
  541 #define TD_CLR_SWAPPED(td)      TD_CLR_INHIB((td), TDI_SWAPPED)
  542 #define TD_CLR_LOCK(td)         TD_CLR_INHIB((td), TDI_LOCK)
  543 #define TD_CLR_SUSPENDED(td)    TD_CLR_INHIB((td), TDI_SUSPENDED)
  544 #define TD_CLR_IWAIT(td)        TD_CLR_INHIB((td), TDI_IWAIT)
  545 
  546 #define TD_SET_RUNNING(td)      (td)->td_state = TDS_RUNNING
  547 #define TD_SET_RUNQ(td)         (td)->td_state = TDS_RUNQ
  548 #define TD_SET_CAN_RUN(td)      (td)->td_state = TDS_CAN_RUN
  549 
  550 #define TD_SBDRY_INTR(td) \
  551     (((td)->td_flags & (TDF_SEINTR | TDF_SERESTART)) != 0)
  552 #define TD_SBDRY_ERRNO(td) \
  553     (((td)->td_flags & TDF_SEINTR) != 0 ? EINTR : ERESTART)
  554 
  555 /*
  556  * Process structure.
  557  */
  558 struct proc {
  559         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
  560         TAILQ_HEAD(, thread) p_threads; /* (c) all threads. */
  561         struct mtx      p_slock;        /* process spin lock */
  562         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
  563         struct filedesc *p_fd;          /* (b) Open files. */
  564         struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
  565         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
  566         struct plimit   *p_limit;       /* (c) Resource limits. */
  567         struct callout  p_limco;        /* (c) Limit callout handle */
  568         struct sigacts  *p_sigacts;     /* (x) Signal actions, state (CPU). */
  569 
  570         int             p_flag;         /* (c) P_* flags. */
  571         int             p_flag2;        /* (c) P2_* flags. */
  572         enum {
  573                 PRS_NEW = 0,            /* In creation */
  574                 PRS_NORMAL,             /* threads can be run. */
  575                 PRS_ZOMBIE
  576         } p_state;                      /* (j/c) Process status. */
  577         pid_t           p_pid;          /* (b) Process identifier. */
  578         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
  579         LIST_ENTRY(proc) p_pglist;      /* (g + e) List of processes in pgrp. */
  580         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
  581         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
  582         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
  583         struct proc     *p_reaper;      /* (e) My reaper. */
  584         LIST_HEAD(, proc) p_reaplist;   /* (e) List of my descendants
  585                                                (if I am reaper). */
  586         LIST_ENTRY(proc) p_reapsibling; /* (e) List of siblings - descendants of
  587                                                the same reaper. */
  588         struct mtx      p_mtx;          /* (n) Lock for this struct. */
  589         struct mtx      p_statmtx;      /* Lock for the stats */
  590         struct mtx      p_itimmtx;      /* Lock for the virt/prof timers */
  591         struct mtx      p_profmtx;      /* Lock for the profiling */
  592         struct ksiginfo *p_ksi; /* Locked by parent proc lock */
  593         sigqueue_t      p_sigqueue;     /* (c) Sigs not delivered to a td. */
  594 #define p_siglist       p_sigqueue.sq_signals
  595         pid_t           p_oppid;        /* (c + e) Real parent pid. */
  596 
  597 /* The following fields are all zeroed upon creation in fork. */
  598 #define p_startzero     p_vmspace
  599         struct vmspace  *p_vmspace;     /* (b) Address space. */
  600         u_int           p_swtick;       /* (c) Tick when swapped in or out. */
  601         u_int           p_cowgen;       /* (c) Generation of COW pointers. */
  602         struct itimerval p_realtimer;   /* (c) Alarm timer. */
  603         struct rusage   p_ru;           /* (a) Exit information. */
  604         struct rusage_ext p_rux;        /* (cu) Internal resource usage. */
  605         struct rusage_ext p_crux;       /* (c) Internal child resource usage. */
  606         int             p_profthreads;  /* (c) Num threads in addupc_task. */
  607         volatile int    p_exitthreads;  /* (j) Number of threads exiting */
  608         int             p_traceflag;    /* (o) Kernel trace points. */
  609         struct vnode    *p_tracevp;     /* (c + o) Trace to vnode. */
  610         struct ucred    *p_tracecred;   /* (o) Credentials to trace with. */
  611         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
  612         u_int           p_lock;         /* (c) Proclock (prevent swap) count. */
  613         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
  614         int             p_sigparent;    /* (c) Signal to parent on exit. */
  615         int             p_sig;          /* (n) For core dump/debugger XXX. */
  616         u_long          p_code;         /* (n) For core dump/debugger XXX. */
  617         u_int           p_stops;        /* (c) Stop event bitmask. */
  618         u_int           p_stype;        /* (c) Stop event type. */
  619         char            p_step;         /* (c) Process is stopped. */
  620         u_char          p_pfsflags;     /* (c) Procfs flags. */
  621         u_int           p_ptevents;     /* (c + e) ptrace() event mask. */
  622         struct nlminfo  *p_nlminfo;     /* (?) Only used by/for lockd. */
  623         struct kaioinfo *p_aioinfo;     /* (y) ASYNC I/O info. */
  624         struct thread   *p_singlethread;/* (c + j) If single threading this is it */
  625         int             p_suspcount;    /* (j) Num threads in suspended mode. */
  626         struct thread   *p_xthread;     /* (c) Trap thread */
  627         int             p_boundary_count;/* (j) Num threads at user boundary */
  628         int             p_pendingcnt;   /* how many signals are pending */
  629         struct itimers  *p_itimers;     /* (c) POSIX interval timers. */
  630         struct procdesc *p_procdesc;    /* (e) Process descriptor, if any. */
  631         u_int           p_treeflag;     /* (e) P_TREE flags */
  632         int             p_pendingexits; /* (c) Count of pending thread exits. */
  633         struct filemon  *p_filemon;     /* (c) filemon-specific data. */
  634         int             p_pdeathsig;    /* (c) Signal from parent on exit. */
  635 /* End area that is zeroed on creation. */
  636 #define p_endzero       p_magic
  637 
  638 /* The following fields are all copied upon creation in fork. */
  639 #define p_startcopy     p_endzero
  640         u_int           p_magic;        /* (b) Magic number. */
  641         int             p_osrel;        /* (x) osreldate for the
  642                                                binary (from ELF note, if any) */
  643         char            p_comm[MAXCOMLEN + 1];  /* (x) Process name. */
  644         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
  645         struct pargs    *p_args;        /* (c) Process arguments. */
  646         rlim_t          p_cpulimit;     /* (c) Current CPU limit in seconds. */
  647         signed char     p_nice;         /* (c) Process "nice" value. */
  648         int             p_fibnum;       /* in this routing domain XXX MRT */
  649         pid_t           p_reapsubtree;  /* (e) Pid of the direct child of the
  650                                                reaper which spawned
  651                                                our subtree. */
  652         uint16_t        p_elf_machine;  /* (x) ELF machine type */
  653         uint64_t        p_elf_flags;    /* (x) ELF flags */
  654 /* End area that is copied on creation. */
  655 #define p_endcopy       p_xexit
  656 
  657         u_int           p_xexit;        /* (c) Exit code. */
  658         u_int           p_xsig;         /* (c) Stop/kill sig. */
  659         struct pgrp     *p_pgrp;        /* (c + e) Pointer to process group. */
  660         struct knlist   *p_klist;       /* (c) Knotes attached to this proc. */
  661         int             p_numthreads;   /* (c) Number of threads. */
  662         struct mdproc   p_md;           /* Any machine-dependent fields. */
  663         struct callout  p_itcallout;    /* (h + c) Interval timer callout. */
  664         u_short         p_acflag;       /* (c) Accounting flags. */
  665         struct proc     *p_peers;       /* (r) */
  666         struct proc     *p_leader;      /* (b) */
  667         void            *p_emuldata;    /* (c) Emulator state data. */
  668         struct label    *p_label;       /* (*) Proc (not subject) MAC label. */
  669         STAILQ_HEAD(, ktr_request)      p_ktr;  /* (o) KTR event queue. */
  670         LIST_HEAD(, mqueue_notifier)    p_mqnotifier; /* (c) mqueue notifiers.*/
  671         struct kdtrace_proc     *p_dtrace; /* (*) DTrace-specific data. */
  672         struct cv       p_pwait;        /* (*) wait cv for exit/exec. */
  673         uint64_t        p_prev_runtime; /* (c) Resource usage accounting. */
  674         struct racct    *p_racct;       /* (b) Resource accounting. */
  675         int             p_throttled;    /* (c) Flag for racct pcpu throttling */
  676         /*
  677          * An orphan is the child that has been re-parented to the
  678          * debugger as a result of attaching to it.  Need to keep
  679          * track of them for parent to be able to collect the exit
  680          * status of what used to be children.
  681          */
  682         LIST_ENTRY(proc) p_orphan;      /* (e) List of orphan processes. */
  683         LIST_HEAD(, proc) p_orphans;    /* (e) Pointer to list of orphans. */
  684         uint32_t        p_fctl0;        /* (x) ABI feature control, ELF note */
  685         u_int           p_amd64_md_flags; /* (c) md process flags P_MD */
  686 };
  687 
  688 #define p_session       p_pgrp->pg_session
  689 #define p_pgid          p_pgrp->pg_id
  690 
  691 #define NOCPU           (-1)    /* For when we aren't on a CPU. */
  692 #define NOCPU_OLD       (255)
  693 #define MAXCPU_OLD      (254)
  694 
  695 #define PROC_SLOCK(p)   mtx_lock_spin(&(p)->p_slock)
  696 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
  697 #define PROC_SLOCK_ASSERT(p, type)      mtx_assert(&(p)->p_slock, (type))
  698 
  699 #define PROC_STATLOCK(p)        mtx_lock_spin(&(p)->p_statmtx)
  700 #define PROC_STATUNLOCK(p)      mtx_unlock_spin(&(p)->p_statmtx)
  701 #define PROC_STATLOCK_ASSERT(p, type)   mtx_assert(&(p)->p_statmtx, (type))
  702 
  703 #define PROC_ITIMLOCK(p)        mtx_lock_spin(&(p)->p_itimmtx)
  704 #define PROC_ITIMUNLOCK(p)      mtx_unlock_spin(&(p)->p_itimmtx)
  705 #define PROC_ITIMLOCK_ASSERT(p, type)   mtx_assert(&(p)->p_itimmtx, (type))
  706 
  707 #define PROC_PROFLOCK(p)        mtx_lock_spin(&(p)->p_profmtx)
  708 #define PROC_PROFUNLOCK(p)      mtx_unlock_spin(&(p)->p_profmtx)
  709 #define PROC_PROFLOCK_ASSERT(p, type)   mtx_assert(&(p)->p_profmtx, (type))
  710 
  711 /* These flags are kept in p_flag. */
  712 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
  713 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
  714 #define P_KPROC         0x00004 /* Kernel process. */
  715 #define P_UNUSED3       0x00008 /* --available-- */
  716 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
  717 #define P_PROFIL        0x00020 /* Has started profiling. */
  718 #define P_STOPPROF      0x00040 /* Has thread requesting to stop profiling. */
  719 #define P_HADTHREADS    0x00080 /* Has had threads (no cleanup shortcuts) */
  720 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
  721 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
  722 #define P_SINGLE_EXIT   0x00400 /* Threads suspending should exit, not wait. */
  723 #define P_TRACED        0x00800 /* Debugged process being traced. */
  724 #define P_WAITED        0x01000 /* Someone is waiting for us. */
  725 #define P_WEXIT         0x02000 /* Working on exiting. */
  726 #define P_EXEC          0x04000 /* Process called exec. */
  727 #define P_WKILLED       0x08000 /* Killed, go to kernel/user boundary ASAP. */
  728 #define P_CONTINUED     0x10000 /* Proc has continued from a stopped state. */
  729 #define P_STOPPED_SIG   0x20000 /* Stopped due to SIGSTOP/SIGTSTP. */
  730 #define P_STOPPED_TRACE 0x40000 /* Stopped because of tracing. */
  731 #define P_STOPPED_SINGLE 0x80000 /* Only 1 thread can continue (not to user). */
  732 #define P_PROTECTED     0x100000 /* Do not kill on memory overcommit. */
  733 #define P_SIGEVENT      0x200000 /* Process pending signals changed. */
  734 #define P_SINGLE_BOUNDARY 0x400000 /* Threads should suspend at user boundary. */
  735 #define P_HWPMC         0x800000 /* Process is using HWPMCs */
  736 #define P_JAILED        0x1000000 /* Process is in jail. */
  737 #define P_TOTAL_STOP    0x2000000 /* Stopped in stop_all_proc. */
  738 #define P_INEXEC        0x4000000 /* Process is in execve(). */
  739 #define P_STATCHILD     0x8000000 /* Child process stopped or exited. */
  740 #define P_INMEM         0x10000000 /* Loaded into memory. */
  741 #define P_SWAPPINGOUT   0x20000000 /* Process is being swapped out. */
  742 #define P_SWAPPINGIN    0x40000000 /* Process is being swapped in. */
  743 #define P_PPTRACE       0x80000000 /* PT_TRACEME by vforked child. */
  744 
  745 #define P_STOPPED       (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
  746 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
  747 #define P_KILLED(p)     ((p)->p_flag & P_WKILLED)
  748 
  749 /* These flags are kept in p_flag2. */
  750 #define P2_INHERIT_PROTECTED 0x00000001 /* New children get P_PROTECTED. */
  751 #define P2_NOTRACE      0x00000002      /* No ptrace(2) attach or coredumps. */
  752 #define P2_NOTRACE_EXEC 0x00000004      /* Keep P2_NOPTRACE on exec(2). */
  753 #define P2_AST_SU       0x00000008      /* Handles SU ast for kthreads. */
  754 #define P2_PTRACE_FSTP  0x00000010 /* SIGSTOP from PT_ATTACH not yet handled. */
  755 #define P2_TRAPCAP      0x00000020      /* SIGTRAP on ENOTCAPABLE */
  756 #define P2_ASLR_ENABLE  0x00000040      /* Force enable ASLR. */
  757 #define P2_ASLR_DISABLE 0x00000080      /* Force disable ASLR. */
  758 #define P2_ASLR_IGNSTART 0x00000100     /* Enable ASLR to consume sbrk area. */
  759 
  760 /* Flags protected by proctree_lock, kept in p_treeflags. */
  761 #define P_TREE_ORPHANED         0x00000001      /* Reparented, on orphan list */
  762 #define P_TREE_FIRST_ORPHAN     0x00000002      /* First element of orphan
  763                                                    list */
  764 #define P_TREE_REAPER           0x00000004      /* Reaper of subtree */
  765 
  766 /*
  767  * These were process status values (p_stat), now they are only used in
  768  * legacy conversion code.
  769  */
  770 #define SIDL    1               /* Process being created by fork. */
  771 #define SRUN    2               /* Currently runnable. */
  772 #define SSLEEP  3               /* Sleeping on an address. */
  773 #define SSTOP   4               /* Process debugging or suspension. */
  774 #define SZOMB   5               /* Awaiting collection by parent. */
  775 #define SWAIT   6               /* Waiting for interrupt. */
  776 #define SLOCK   7               /* Blocked on a lock. */
  777 
  778 #define P_MAGIC         0xbeefface
  779 
  780 #ifdef _KERNEL
  781 
  782 /* Types and flags for mi_switch(). */
  783 #define SW_TYPE_MASK            0xff    /* First 8 bits are switch type */
  784 #define SWT_NONE                0       /* Unspecified switch. */
  785 #define SWT_PREEMPT             1       /* Switching due to preemption. */
  786 #define SWT_OWEPREEMPT          2       /* Switching due to owepreempt. */
  787 #define SWT_TURNSTILE           3       /* Turnstile contention. */
  788 #define SWT_SLEEPQ              4       /* Sleepq wait. */
  789 #define SWT_SLEEPQTIMO          5       /* Sleepq timeout wait. */
  790 #define SWT_RELINQUISH          6       /* yield call. */
  791 #define SWT_NEEDRESCHED         7       /* NEEDRESCHED was set. */
  792 #define SWT_IDLE                8       /* Switching from the idle thread. */
  793 #define SWT_IWAIT               9       /* Waiting for interrupts. */
  794 #define SWT_SUSPEND             10      /* Thread suspended. */
  795 #define SWT_REMOTEPREEMPT       11      /* Remote processor preempted. */
  796 #define SWT_REMOTEWAKEIDLE      12      /* Remote processor preempted idle. */
  797 #define SWT_COUNT               13      /* Number of switch types. */
  798 /* Flags */
  799 #define SW_VOL          0x0100          /* Voluntary switch. */
  800 #define SW_INVOL        0x0200          /* Involuntary switch. */
  801 #define SW_PREEMPT      0x0400          /* The invol switch is a preemption */
  802 
  803 /* How values for thread_single(). */
  804 #define SINGLE_NO_EXIT  0
  805 #define SINGLE_EXIT     1
  806 #define SINGLE_BOUNDARY 2
  807 #define SINGLE_ALLPROC  3
  808 
  809 #ifdef MALLOC_DECLARE
  810 MALLOC_DECLARE(M_PARGS);
  811 MALLOC_DECLARE(M_PGRP);
  812 MALLOC_DECLARE(M_SESSION);
  813 MALLOC_DECLARE(M_SUBPROC);
  814 #endif
  815 
  816 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
  817         LIST_FOREACH((p), &allproc, p_list)
  818 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
  819         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
  820 
  821 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
  822 
  823 /*
  824  * We use process IDs <= pid_max <= PID_MAX; PID_MAX + 1 must also fit
  825  * in a pid_t, as it is used to represent "no process group".
  826  */
  827 #define PID_MAX         99999
  828 #define NO_PID          100000
  829 extern pid_t pid_max;
  830 
  831 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
  832 
  833 
  834 #define STOPEVENT(p, e, v) do {                                         \
  835         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,                 \
  836             "checking stopevent %d", (e));                              \
  837         if ((p)->p_stops & (e)) {                                       \
  838                 PROC_LOCK(p);                                           \
  839                 stopevent((p), (e), (v));                               \
  840                 PROC_UNLOCK(p);                                         \
  841         }                                                               \
  842 } while (0)
  843 #define _STOPEVENT(p, e, v) do {                                        \
  844         PROC_LOCK_ASSERT(p, MA_OWNED);                                  \
  845         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.lock_object, \
  846             "checking stopevent %d", (e));                              \
  847         if ((p)->p_stops & (e))                                         \
  848                 stopevent((p), (e), (v));                               \
  849 } while (0)
  850 
  851 /* Lock and unlock a process. */
  852 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
  853 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
  854 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
  855 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
  856 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
  857 
  858 /* Lock and unlock a process group. */
  859 #define PGRP_LOCK(pg)   mtx_lock(&(pg)->pg_mtx)
  860 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
  861 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
  862 #define PGRP_LOCK_ASSERT(pg, type)      mtx_assert(&(pg)->pg_mtx, (type))
  863 
  864 #define PGRP_LOCK_PGSIGNAL(pg) do {                                     \
  865         if ((pg) != NULL)                                               \
  866                 PGRP_LOCK(pg);                                          \
  867 } while (0)
  868 #define PGRP_UNLOCK_PGSIGNAL(pg) do {                                   \
  869         if ((pg) != NULL)                                               \
  870                 PGRP_UNLOCK(pg);                                        \
  871 } while (0)
  872 
  873 /* Lock and unlock a session. */
  874 #define SESS_LOCK(s)    mtx_lock(&(s)->s_mtx)
  875 #define SESS_UNLOCK(s)  mtx_unlock(&(s)->s_mtx)
  876 #define SESS_LOCKED(s)  mtx_owned(&(s)->s_mtx)
  877 #define SESS_LOCK_ASSERT(s, type)       mtx_assert(&(s)->s_mtx, (type))
  878 
  879 /*
  880  * Non-zero p_lock ensures that:
  881  * - exit1() is not performed until p_lock reaches zero;
  882  * - the process' threads stack are not swapped out if they are currently
  883  *   not (P_INMEM).
  884  *
  885  * PHOLD() asserts that the process (except the current process) is
  886  * not exiting, increments p_lock and swaps threads stacks into memory,
  887  * if needed.
  888  * _PHOLD() is same as PHOLD(), it takes the process locked.
  889  * _PHOLD_LITE() also takes the process locked, but comparing with
  890  * _PHOLD(), it only guarantees that exit1() is not executed,
  891  * faultin() is not called.
  892  */
  893 #define PHOLD(p) do {                                                   \
  894         PROC_LOCK(p);                                                   \
  895         _PHOLD(p);                                                      \
  896         PROC_UNLOCK(p);                                                 \
  897 } while (0)
  898 #define _PHOLD(p) do {                                                  \
  899         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
  900         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
  901             ("PHOLD of exiting process %p", p));                        \
  902         (p)->p_lock++;                                                  \
  903         if (((p)->p_flag & P_INMEM) == 0)                               \
  904                 faultin((p));                                           \
  905 } while (0)
  906 #define _PHOLD_LITE(p) do {                                             \
  907         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
  908         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
  909             ("PHOLD of exiting process %p", p));                        \
  910         (p)->p_lock++;                                                  \
  911 } while (0)
  912 #define PROC_ASSERT_HELD(p) do {                                        \
  913         KASSERT((p)->p_lock > 0, ("process %p not held", p));           \
  914 } while (0)
  915 
  916 #define PRELE(p) do {                                                   \
  917         PROC_LOCK((p));                                                 \
  918         _PRELE((p));                                                    \
  919         PROC_UNLOCK((p));                                               \
  920 } while (0)
  921 #define _PRELE(p) do {                                                  \
  922         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
  923         PROC_ASSERT_HELD(p);                                            \
  924         (--(p)->p_lock);                                                \
  925         if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0)                \
  926                 wakeup(&(p)->p_lock);                                   \
  927 } while (0)
  928 #define PROC_ASSERT_NOT_HELD(p) do {                                    \
  929         KASSERT((p)->p_lock == 0, ("process %p held", p));              \
  930 } while (0)
  931 
  932 #define PROC_UPDATE_COW(p) do {                                         \
  933         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
  934         (p)->p_cowgen++;                                                \
  935 } while (0)
  936 
  937 /* Check whether a thread is safe to be swapped out. */
  938 #define thread_safetoswapout(td)        ((td)->td_flags & TDF_CANSWAP)
  939 
  940 /* Control whether or not it is safe for curthread to sleep. */
  941 #define THREAD_NO_SLEEPING()            ((curthread)->td_no_sleeping++)
  942 
  943 #define THREAD_SLEEPING_OK()            ((curthread)->td_no_sleeping--)
  944 
  945 #define THREAD_CAN_SLEEP()              ((curthread)->td_no_sleeping == 0)
  946 
  947 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
  948 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
  949 extern u_long pidhash;
  950 #define TIDHASH(tid)    (&tidhashtbl[(tid) & tidhash])
  951 extern LIST_HEAD(tidhashhead, thread) *tidhashtbl;
  952 extern u_long tidhash;
  953 extern struct rwlock tidhash_lock;
  954 
  955 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
  956 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
  957 extern u_long pgrphash;
  958 
  959 extern struct sx allproc_lock;
  960 extern int allproc_gen;
  961 extern struct sx proctree_lock;
  962 extern struct mtx ppeers_lock;
  963 extern struct proc proc0;               /* Process slot for swapper. */
  964 extern struct thread0_storage thread0_st;       /* Primary thread in proc0. */
  965 #define thread0 (thread0_st.t0st_thread)
  966 extern struct vmspace vmspace0;         /* VM space for proc0. */
  967 extern int hogticks;                    /* Limit on kernel cpu hogs. */
  968 extern int lastpid;
  969 extern int nprocs, maxproc;             /* Current and max number of procs. */
  970 extern int maxprocperuid;               /* Max procs per uid. */
  971 extern u_long ps_arg_cache_limit;
  972 
  973 LIST_HEAD(proclist, proc);
  974 TAILQ_HEAD(procqueue, proc);
  975 TAILQ_HEAD(threadqueue, thread);
  976 extern struct proclist allproc;         /* List of all processes. */
  977 extern struct proclist zombproc;        /* List of zombie processes. */
  978 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
  979 
  980 extern struct uma_zone *proc_zone;
  981 
  982 struct  proc *pfind(pid_t);             /* Find process by id. */
  983 struct  proc *pfind_any(pid_t);         /* Find (zombie) process by id. */
  984 struct  proc *pfind_locked(pid_t pid);
  985 struct  pgrp *pgfind(pid_t);            /* Find process group by id. */
  986 struct  proc *zpfind(pid_t);            /* Find zombie process by id. */
  987 
  988 struct  fork_req {
  989         int             fr_flags;
  990         int             fr_pages;
  991         int             *fr_pidp;
  992         struct proc     **fr_procp;
  993         int             *fr_pd_fd;
  994         int             fr_pd_flags;
  995         struct filecaps *fr_pd_fcaps;
  996 };
  997 
  998 /*
  999  * pget() flags.
 1000  */
 1001 #define PGET_HOLD       0x00001 /* Hold the process. */
 1002 #define PGET_CANSEE     0x00002 /* Check against p_cansee(). */
 1003 #define PGET_CANDEBUG   0x00004 /* Check against p_candebug(). */
 1004 #define PGET_ISCURRENT  0x00008 /* Check that the found process is current. */
 1005 #define PGET_NOTWEXIT   0x00010 /* Check that the process is not in P_WEXIT. */
 1006 #define PGET_NOTINEXEC  0x00020 /* Check that the process is not in P_INEXEC. */
 1007 #define PGET_NOTID      0x00040 /* Do not assume tid if pid > PID_MAX. */
 1008 
 1009 #define PGET_WANTREAD   (PGET_HOLD | PGET_CANDEBUG | PGET_NOTWEXIT)
 1010 
 1011 int     pget(pid_t pid, int flags, struct proc **pp);
 1012 
 1013 void    ast(struct trapframe *framep);
 1014 struct  thread *choosethread(void);
 1015 int     cr_cansee(struct ucred *u1, struct ucred *u2);
 1016 int     cr_canseesocket(struct ucred *cred, struct socket *so);
 1017 int     cr_canseeothergids(struct ucred *u1, struct ucred *u2);
 1018 int     cr_canseeotheruids(struct ucred *u1, struct ucred *u2);
 1019 int     cr_canseejailproc(struct ucred *u1, struct ucred *u2);
 1020 int     cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
 1021 int     enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
 1022             struct session *sess);
 1023 int     enterthispgrp(struct proc *p, struct pgrp *pgrp);
 1024 void    faultin(struct proc *p);
 1025 void    fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
 1026 int     fork1(struct thread *, struct fork_req *);
 1027 void    fork_exit(void (*)(void *, struct trapframe *), void *,
 1028             struct trapframe *);
 1029 void    fork_return(struct thread *, struct trapframe *);
 1030 int     inferior(struct proc *p);
 1031 void    kern_proc_vmmap_resident(struct vm_map *map, struct vm_map_entry *entry,
 1032             int *resident_count, bool *super);
 1033 void    kern_yield(int);
 1034 void    kick_proc0(void);
 1035 void    killjobc(void);
 1036 int     leavepgrp(struct proc *p);
 1037 int     maybe_preempt(struct thread *td);
 1038 void    maybe_yield(void);
 1039 void    mi_switch(int flags, struct thread *newtd);
 1040 int     p_candebug(struct thread *td, struct proc *p);
 1041 int     p_cansee(struct thread *td, struct proc *p);
 1042 int     p_cansched(struct thread *td, struct proc *p);
 1043 int     p_cansignal(struct thread *td, struct proc *p, int signum);
 1044 int     p_canwait(struct thread *td, struct proc *p);
 1045 struct  pargs *pargs_alloc(int len);
 1046 void    pargs_drop(struct pargs *pa);
 1047 void    pargs_hold(struct pargs *pa);
 1048 int     proc_getargv(struct thread *td, struct proc *p, struct sbuf *sb);
 1049 int     proc_getauxv(struct thread *td, struct proc *p, struct sbuf *sb);
 1050 int     proc_getenvv(struct thread *td, struct proc *p, struct sbuf *sb);
 1051 void    procinit(void);
 1052 void    proc_linkup0(struct proc *p, struct thread *td);
 1053 void    proc_linkup(struct proc *p, struct thread *td);
 1054 struct proc *proc_realparent(struct proc *child);
 1055 void    proc_reap(struct thread *td, struct proc *p, int *status, int options);
 1056 void    proc_reparent(struct proc *child, struct proc *newparent, bool set_oppid);
 1057 void    proc_set_traced(struct proc *p, bool stop);
 1058 void    proc_wkilled(struct proc *p);
 1059 struct  pstats *pstats_alloc(void);
 1060 void    pstats_fork(struct pstats *src, struct pstats *dst);
 1061 void    pstats_free(struct pstats *ps);
 1062 void    reaper_abandon_children(struct proc *p, bool exiting);
 1063 int     securelevel_ge(struct ucred *cr, int level);
 1064 int     securelevel_gt(struct ucred *cr, int level);
 1065 void    sess_hold(struct session *);
 1066 void    sess_release(struct session *);
 1067 int     setrunnable(struct thread *);
 1068 void    setsugid(struct proc *p);
 1069 int     should_yield(void);
 1070 int     sigonstack(size_t sp);
 1071 void    stopevent(struct proc *, u_int, u_int);
 1072 struct  thread *tdfind(lwpid_t, pid_t);
 1073 void    threadinit(void);
 1074 void    tidhash_add(struct thread *);
 1075 void    tidhash_remove(struct thread *);
 1076 void    cpu_idle(int);
 1077 int     cpu_idle_wakeup(int);
 1078 extern  void (*cpu_idle_hook)(sbintime_t);      /* Hook to machdep CPU idler. */
 1079 void    cpu_switch(struct thread *, struct thread *, struct mtx *);
 1080 void    cpu_throw(struct thread *, struct thread *) __dead2;
 1081 void    unsleep(struct thread *);
 1082 void    userret(struct thread *, struct trapframe *);
 1083 
 1084 void    cpu_exit(struct thread *);
 1085 void    exit1(struct thread *, int, int) __dead2;
 1086 void    cpu_copy_thread(struct thread *td, struct thread *td0);
 1087 bool    cpu_exec_vmspace_reuse(struct proc *p, struct vm_map *map);
 1088 int     cpu_fetch_syscall_args(struct thread *td);
 1089 void    cpu_fork(struct thread *, struct proc *, struct thread *, int);
 1090 void    cpu_fork_kthread_handler(struct thread *, void (*)(void *), void *);
 1091 int     cpu_procctl(struct thread *td, int idtype, id_t id, int com,
 1092             void *data);
 1093 void    cpu_set_syscall_retval(struct thread *, int);
 1094 void    cpu_set_upcall(struct thread *, void (*)(void *), void *,
 1095             stack_t *);
 1096 int     cpu_set_user_tls(struct thread *, void *tls_base);
 1097 void    cpu_thread_alloc(struct thread *);
 1098 void    cpu_thread_clean(struct thread *);
 1099 void    cpu_thread_exit(struct thread *);
 1100 void    cpu_thread_free(struct thread *);
 1101 void    cpu_thread_swapin(struct thread *);
 1102 void    cpu_thread_swapout(struct thread *);
 1103 struct  thread *thread_alloc(int pages);
 1104 int     thread_alloc_stack(struct thread *, int pages);
 1105 void    thread_cow_get_proc(struct thread *newtd, struct proc *p);
 1106 void    thread_cow_get(struct thread *newtd, struct thread *td);
 1107 void    thread_cow_free(struct thread *td);
 1108 void    thread_cow_update(struct thread *td);
 1109 int     thread_create(struct thread *td, struct rtprio *rtp,
 1110             int (*initialize_thread)(struct thread *, void *), void *thunk);
 1111 void    thread_exit(void) __dead2;
 1112 void    thread_free(struct thread *td);
 1113 void    thread_link(struct thread *td, struct proc *p);
 1114 void    thread_reap(void);
 1115 int     thread_single(struct proc *p, int how);
 1116 void    thread_single_end(struct proc *p, int how);
 1117 void    thread_stash(struct thread *td);
 1118 void    thread_stopped(struct proc *p);
 1119 void    childproc_stopped(struct proc *child, int reason);
 1120 void    childproc_continued(struct proc *child);
 1121 void    childproc_exited(struct proc *child);
 1122 int     thread_suspend_check(int how);
 1123 bool    thread_suspend_check_needed(void);
 1124 void    thread_suspend_switch(struct thread *, struct proc *p);
 1125 void    thread_suspend_one(struct thread *td);
 1126 void    thread_unlink(struct thread *td);
 1127 void    thread_unsuspend(struct proc *p);
 1128 void    thread_wait(struct proc *p);
 1129 struct thread   *thread_find(struct proc *p, lwpid_t tid);
 1130 
 1131 void    stop_all_proc(void);
 1132 void    resume_all_proc(void);
 1133 
 1134 static __inline int
 1135 curthread_pflags_set(int flags)
 1136 {
 1137         struct thread *td;
 1138         int save;
 1139 
 1140         td = curthread;
 1141         save = ~flags | (td->td_pflags & flags);
 1142         td->td_pflags |= flags;
 1143         return (save);
 1144 }
 1145 
 1146 static __inline void
 1147 curthread_pflags_restore(int save)
 1148 {
 1149 
 1150         curthread->td_pflags &= save;
 1151 }
 1152 
 1153 static __inline __pure2 struct td_sched *
 1154 td_get_sched(struct thread *td)
 1155 {
 1156 
 1157         return ((struct td_sched *)&td[1]);
 1158 }
 1159 
 1160 extern void (*softdep_ast_cleanup)(struct thread *);
 1161 static __inline void
 1162 td_softdep_cleanup(struct thread *td)
 1163 {
 1164 
 1165         if (td->td_su != NULL && softdep_ast_cleanup != NULL)
 1166                 softdep_ast_cleanup(td);
 1167 }
 1168 
 1169 #endif  /* _KERNEL */
 1170 
 1171 #endif  /* !_SYS_PROC_H_ */

Cache object: 91c88b6fb2dda8e1cac4c96b6c9ab176


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.