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