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