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