xref: /openbsd/sys/sys/proc.h (revision 3ed32226)
1 /*	$OpenBSD: proc.h,v 1.360 2024/04/18 10:29:39 claudio Exp $	*/
2 /*	$NetBSD: proc.h,v 1.44 1996/04/22 01:23:21 christos Exp $	*/
3 
4 /*-
5  * Copyright (c) 1986, 1989, 1991, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  * (c) UNIX System Laboratories, Inc.
8  * All or some portions of this file are derived from material licensed
9  * to the University of California by American Telephone and Telegraph
10  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
11  * the permission of UNIX System Laboratories, Inc.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)proc.h	8.8 (Berkeley) 1/21/94
38  */
39 
40 #ifndef _SYS_PROC_H_
41 #define	_SYS_PROC_H_
42 
43 #include <machine/proc.h>		/* Machine-dependent proc substruct. */
44 #include <sys/selinfo.h>		/* For struct selinfo */
45 #include <sys/syslimits.h>		/* For LOGIN_NAME_MAX */
46 #include <sys/queue.h>
47 #include <sys/timeout.h>		/* For struct timeout */
48 #include <sys/event.h>			/* For struct klist */
49 #include <sys/mutex.h>			/* For struct mutex */
50 #include <sys/resource.h>		/* For struct rusage */
51 #include <sys/rwlock.h>			/* For struct rwlock */
52 #include <sys/sigio.h>			/* For struct sigio */
53 
54 #ifdef _KERNEL
55 #include <sys/atomic.h>
56 #define __need_process
57 #endif
58 
59 /*
60  * One structure allocated per session.
61  */
62 struct process;
63 struct	session {
64 	int	s_count;		/* Ref cnt; pgrps in session. */
65 	struct	process *s_leader;	/* Session leader. */
66 	struct	vnode *s_ttyvp;		/* Vnode of controlling terminal. */
67 	struct	tty *s_ttyp;		/* Controlling terminal. */
68 	char	s_login[LOGIN_NAME_MAX];	/* Setlogin() name. */
69 	pid_t	s_verauthppid;
70 	uid_t	s_verauthuid;
71 	struct timeout s_verauthto;
72 };
73 
74 void zapverauth(/* struct session */ void *);
75 
76 /*
77  * One structure allocated per process group.
78  */
79 struct	pgrp {
80 	LIST_ENTRY(pgrp) pg_hash;	/* Hash chain. */
81 	LIST_HEAD(, process) pg_members;/* Pointer to pgrp members. */
82 	struct	session *pg_session;	/* Pointer to session. */
83 	struct	sigiolst pg_sigiolst;	/* List of sigio structures. */
84 	pid_t	pg_id;			/* Pgrp id. */
85 	int	pg_jobc;	/* # procs qualifying pgrp for job control */
86 };
87 
88 /*
89  * time usage: accumulated times in ticks
90  * Once a second, each thread's immediate counts (p_[usi]ticks) are
91  * accumulated into these.
92  */
93 struct tusage {
94 	struct	timespec tu_runtime;	/* Realtime. */
95 	uint64_t	tu_uticks;	/* Statclock hits in user mode. */
96 	uint64_t	tu_sticks;	/* Statclock hits in system mode. */
97 	uint64_t	tu_iticks;	/* Statclock hits processing intr. */
98 };
99 
100 /*
101  * Description of a process.
102  *
103  * These structures contain the information needed to manage a thread of
104  * control, known in UN*X as a process; it has references to substructures
105  * containing descriptions of things that the process uses, but may share
106  * with related processes.
107  *
108  * struct process is the higher level process containing information
109  * shared by all threads in a process, while struct proc contains the
110  * run-time information needed by threads.
111  */
112 #ifdef __need_process
113 struct futex;
114 LIST_HEAD(futex_list, futex);
115 struct proc;
116 struct tslpentry;
117 TAILQ_HEAD(tslpqueue, tslpentry);
118 struct unveil;
119 
120 struct pinsyscall {
121 	vaddr_t		pn_start;
122 	vaddr_t		pn_end;
123 	u_int		*pn_pins; /* array of offsets indexed by syscall# */
124 	int		pn_npins; /* number of entries in table */
125 };
126 
127 /*
128  * Locks used to protect struct members in this file:
129  *	I	immutable after creation
130  *	a	atomic operations
131  *	K	kernel lock
132  *	m	this process' `ps_mtx'
133  *	p	this process' `ps_lock'
134  *	R	rlimit_lock
135  *	S	scheduler lock
136  *	T	itimer_mtx
137  */
138 struct process {
139 	/*
140 	 * ps_mainproc is the original thread in the process.
141 	 * It's only still special for the handling of
142 	 * some signal and ptrace behaviors that need to be fixed.
143 	 */
144 	struct	proc *ps_mainproc;
145 	struct	ucred *ps_ucred;	/* Process owner's identity. */
146 
147 	LIST_ENTRY(process) ps_list;	/* List of all processes. */
148 	TAILQ_HEAD(,proc) ps_threads;	/* [K|S] Threads in this process. */
149 
150 	LIST_ENTRY(process) ps_pglist;	/* List of processes in pgrp. */
151 	struct	process *ps_pptr; 	/* Pointer to parent process. */
152 	LIST_ENTRY(process) ps_sibling;	/* List of sibling processes. */
153 	LIST_HEAD(, process) ps_children;/* Pointer to list of children. */
154 	LIST_ENTRY(process) ps_hash;    /* Hash chain. */
155 
156 	/*
157 	 * An orphan is the child that has been re-parented to the
158 	 * debugger as a result of attaching to it.  Need to keep
159 	 * track of them for parent to be able to collect the exit
160 	 * status of what used to be children.
161 	 */
162 	LIST_ENTRY(process) ps_orphan;	/* List of orphan processes. */
163 	LIST_HEAD(, process) ps_orphans;/* Pointer to list of orphans. */
164 
165 	struct	sigiolst ps_sigiolst;	/* List of sigio structures. */
166 	struct	sigacts *ps_sigacts;	/* [I] Signal actions, state */
167 	struct	vnode *ps_textvp;	/* Vnode of executable. */
168 	struct	filedesc *ps_fd;	/* Ptr to open files structure */
169 	struct	vmspace *ps_vmspace;	/* Address space */
170 	pid_t	ps_pid;			/* Process identifier. */
171 
172 	struct	futex_list ps_ftlist;	/* futexes attached to this process */
173 	struct	tslpqueue ps_tslpqueue;	/* [p] queue of threads in thrsleep */
174 	struct	rwlock	ps_lock;	/* per-process rwlock */
175 	struct  mutex	ps_mtx;		/* per-process mutex */
176 
177 /* The following fields are all zeroed upon creation in process_new. */
178 #define	ps_startzero	ps_klist
179 	struct	klist ps_klist;		/* knotes attached to this process */
180 	u_int	ps_flags;		/* [a] PS_* flags. */
181 	int	ps_siglist;		/* Signals pending for the process. */
182 
183 	struct	proc *ps_single;	/* [S] Thread for single-threading. */
184 	u_int	ps_singlecount;		/* [a] Not yet suspended threads. */
185 
186 	int	ps_traceflag;		/* Kernel trace points. */
187 	struct	vnode *ps_tracevp;	/* Trace to vnode. */
188 	struct	ucred *ps_tracecred;	/* Creds for writing trace */
189 
190 	u_int	ps_xexit;		/* Exit status for wait */
191 	int	ps_xsig;		/* Stopping or killing signal */
192 
193 	pid_t	ps_ppid;		/* [a] Cached parent pid */
194 	pid_t	ps_oppid;	 	/* [a] Save parent pid during ptrace. */
195 	int	ps_ptmask;		/* Ptrace event mask */
196 	struct	ptrace_state *ps_ptstat;/* Ptrace state */
197 
198 	struct	rusage *ps_ru;		/* sum of stats for dead threads. */
199 	struct	tusage ps_tu;		/* accumulated times. */
200 	struct	rusage ps_cru;		/* sum of stats for reaped children */
201 	struct	itimerspec ps_timer[3];	/* [m] ITIMER_REAL timer */
202 					/* [T] ITIMER_{VIRTUAL,PROF} timers */
203 	struct	timeout ps_rucheck_to;	/* [] resource limit check timer */
204 	time_t	ps_nextxcpu;		/* when to send next SIGXCPU, */
205 					/* in seconds of process runtime */
206 
207 	u_int64_t ps_wxcounter;
208 
209 	struct unveil *ps_uvpaths;	/* unveil vnodes and names */
210 	ssize_t	ps_uvvcount;		/* count of unveil vnodes held */
211 	size_t	ps_uvncount;		/* count of unveil names allocated */
212 	int	ps_uvdone;		/* no more unveil is permitted */
213 
214 /* End area that is zeroed on creation. */
215 #define	ps_endzero	ps_startcopy
216 
217 /* The following fields are all copied upon creation in process_new. */
218 #define	ps_startcopy	ps_limit
219 	struct	plimit *ps_limit;	/* [m,R] Process limits. */
220 	struct	pgrp *ps_pgrp;		/* Pointer to process group. */
221 
222 	char	ps_comm[_MAXCOMLEN];	/* command name, incl NUL */
223 
224 	vaddr_t	ps_strings;		/* User pointers to argv/env */
225 	vaddr_t	ps_auxinfo;		/* User pointer to auxinfo */
226 	vaddr_t ps_timekeep; 		/* User pointer to timekeep */
227 	vaddr_t	ps_sigcode;		/* [I] User pointer to signal code */
228 	vaddr_t ps_sigcoderet;		/* [I] User ptr to sigreturn retPC */
229 	u_long	ps_sigcookie;		/* [I] */
230 	u_int	ps_rtableid;		/* [a] Process routing table/domain. */
231 	char	ps_nice;		/* Process "nice" value. */
232 
233 	struct uprof {			/* profile arguments */
234 		caddr_t	pr_base;	/* buffer base */
235 		size_t  pr_size;	/* buffer size */
236 		u_long	pr_off;		/* pc offset */
237 		u_int   pr_scale;	/* pc scaling */
238 	} ps_prof;
239 
240 	u_int32_t	ps_acflag;	/* Accounting flags. */
241 
242 	uint64_t ps_pledge;		/* [m] pledge promises */
243 	uint64_t ps_execpledge;		/* [m] execpledge promises */
244 
245 	int64_t ps_kbind_cookie;	/* [m] */
246 	u_long  ps_kbind_addr;		/* [m] */
247 /* an address that can't be in userspace or kernelspace */
248 #define	BOGO_PC	(u_long)-1
249 
250 	struct pinsyscall ps_pin;	/* static or ld.so */
251 	struct pinsyscall ps_libcpin;	/* libc.so, from pinsyscalls(2) */
252 
253 /* End area that is copied on creation. */
254 #define ps_endcopy	ps_threadcnt
255 	u_int	ps_threadcnt;		/* Number of threads. */
256 
257 	struct	timespec ps_start;	/* starting uptime. */
258 	struct	timeout ps_realit_to;	/* [m] ITIMER_REAL timeout */
259 };
260 
261 #define	ps_session	ps_pgrp->pg_session
262 #define	ps_pgid		ps_pgrp->pg_id
263 
264 #endif /* __need_process */
265 
266 /*
267  * These flags are kept in ps_flags.
268  */
269 #define	PS_CONTROLT	0x00000001	/* Has a controlling terminal. */
270 #define	PS_EXEC		0x00000002	/* Process called exec. */
271 #define	PS_INEXEC	0x00000004	/* Process is doing an exec right now */
272 #define	PS_EXITING	0x00000008	/* Process is exiting. */
273 #define	PS_SUGID	0x00000010	/* Had set id privs since last exec. */
274 #define	PS_SUGIDEXEC	0x00000020	/* last execve() was set[ug]id */
275 #define	PS_PPWAIT	0x00000040	/* Parent waits for exec/exit. */
276 #define	PS_ISPWAIT	0x00000080	/* Is parent of PPWAIT child. */
277 #define	PS_PROFIL	0x00000100	/* Has started profiling. */
278 #define	PS_TRACED	0x00000200	/* Being ptraced. */
279 #define	PS_WAITED	0x00000400	/* Stopped proc was waited for. */
280 #define	PS_COREDUMP	0x00000800	/* Busy coredumping */
281 #define	PS_SINGLEEXIT	0x00001000	/* Other threads must die. */
282 #define	PS_SINGLEUNWIND	0x00002000	/* Other threads must unwind. */
283 #define	PS_NOZOMBIE	0x00004000	/* No signal or zombie at exit. */
284 #define	PS_STOPPED	0x00008000	/* Just stopped, need sig to parent. */
285 #define	PS_SYSTEM	0x00010000	/* No sigs, stats or swapping. */
286 #define	PS_EMBRYO	0x00020000	/* New process, not yet fledged */
287 #define	PS_ZOMBIE	0x00040000	/* Dead and ready to be waited for */
288 #define	PS_NOBROADCASTKILL 0x00080000	/* Process excluded from kill -1. */
289 #define	PS_PLEDGE	0x00100000	/* Has called pledge(2) */
290 #define	PS_WXNEEDED	0x00200000	/* Process allowed to violate W^X */
291 #define	PS_EXECPLEDGE	0x00400000	/* Has exec pledges */
292 #define	PS_ORPHAN	0x00800000	/* Process is on an orphan list */
293 #define	PS_CHROOT	0x01000000	/* Process is chrooted */
294 #define	PS_NOBTCFI	0x02000000	/* No Branch Target CFI */
295 #define	PS_ITIMER	0x04000000	/* Virtual interval timers running */
296 #define	PS_PIN		0x08000000	/* ld.so or static syscall pin */
297 #define	PS_LIBCPIN	0x10000000	/* libc.so syscall pin */
298 
299 #define	PS_BITS \
300     ("\20" "\01CONTROLT" "\02EXEC" "\03INEXEC" "\04EXITING" "\05SUGID" \
301      "\06SUGIDEXEC" "\07PPWAIT" "\010ISPWAIT" "\011PROFIL" "\012TRACED" \
302      "\013WAITED" "\014COREDUMP" "\015SINGLEEXIT" "\016SINGLEUNWIND" \
303      "\017NOZOMBIE" "\020STOPPED" "\021SYSTEM" "\022EMBRYO" "\023ZOMBIE" \
304      "\024NOBROADCASTKILL" "\025PLEDGE" "\026WXNEEDED" "\027EXECPLEDGE" \
305      "\030ORPHAN" "\031CHROOT" "\032NOBTCFI" "\033ITIMER")
306 
307 
308 struct kcov_dev;
309 struct lock_list_entry;
310 struct kqueue;
311 
312 struct p_inentry {
313 	u_long	 ie_serial;
314 	vaddr_t	 ie_start;
315 	vaddr_t	 ie_end;
316 };
317 
318 /*
319  *  Locks used to protect struct members in this file:
320  *	I	immutable after creation
321  *	S	scheduler lock
322  *	U	uidinfolk
323  *	l	read only reference, see lim_read_enter()
324  *	o	owned (modified only) by this thread
325  */
326 struct proc {
327 	TAILQ_ENTRY(proc) p_runq;	/* [S] current run/sleep queue */
328 	LIST_ENTRY(proc) p_list;	/* List of all threads. */
329 
330 	struct	process *p_p;		/* [I] The process of this thread. */
331 	TAILQ_ENTRY(proc) p_thr_link;	/* Threads in a process linkage. */
332 
333 	TAILQ_ENTRY(proc) p_fut_link;	/* Threads in a futex linkage. */
334 	struct	futex	*p_futex;	/* Current sleeping futex. */
335 
336 	/* substructures: */
337 	struct	filedesc *p_fd;		/* copy of p_p->ps_fd */
338 	struct	vmspace *p_vmspace;	/* [I] copy of p_p->ps_vmspace */
339 	struct	p_inentry p_spinentry;	/* [o] cache for SP check */
340 
341 	int	p_flag;			/* P_* flags. */
342 	u_char	p_spare;		/* unused */
343 	char	p_stat;			/* [S] S* process status. */
344 	u_char	p_runpri;		/* [S] Runqueue priority */
345 	u_char	p_descfd;		/* if not 255, fdesc permits this fd */
346 
347 	pid_t	p_tid;			/* Thread identifier. */
348 	LIST_ENTRY(proc) p_hash;	/* Hash chain. */
349 
350 /* The following fields are all zeroed upon creation in fork. */
351 #define	p_startzero	p_dupfd
352 	int	p_dupfd;	 /* Sideways return value from filedescopen. XXX */
353 
354 	/* scheduling */
355 	int	p_cpticks;	 /* Ticks of cpu time. */
356 	const volatile void *p_wchan;	/* [S] Sleep address. */
357 	struct	timeout p_sleep_to;/* timeout for tsleep() */
358 	const char *p_wmesg;		/* [S] Reason for sleep. */
359 	fixpt_t	p_pctcpu;		/* [S] %cpu for this thread */
360 	u_int	p_slptime;		/* [S] Time since last blocked. */
361 	u_int	p_uticks;		/* Statclock hits in user mode. */
362 	u_int	p_sticks;		/* Statclock hits in system mode. */
363 	u_int	p_iticks;		/* Statclock hits processing intr. */
364 	struct	cpu_info * volatile p_cpu; /* [S] CPU we're running on. */
365 
366 	struct	rusage p_ru;		/* Statistics */
367 	struct	tusage p_tu;		/* accumulated times. */
368 
369 	struct	plimit	*p_limit;	/* [l] read ref. of p_p->ps_limit */
370 	struct	kcov_dev *p_kd;		/* kcov device handle */
371 	struct	lock_list_entry *p_sleeplocks;	/* WITNESS lock tracking */
372 	struct	kqueue *p_kq;		/* [o] select/poll queue of evts */
373 	unsigned long p_kq_serial;	/* [o] to check against enqueued evts */
374 
375 	int	 p_siglist;		/* [a] Signals arrived & not delivered*/
376 
377 /* End area that is zeroed on creation. */
378 #define	p_endzero	p_startcopy
379 
380 /* The following fields are all copied upon creation in fork. */
381 #define	p_startcopy	p_sigmask
382 	sigset_t p_sigmask;		/* [o] Current signal mask */
383 
384 	char	p_name[_MAXCOMLEN];	/* thread name, incl NUL */
385 	u_char	p_slppri;		/* [S] Sleeping priority */
386 	u_char	p_usrpri;	/* [S] Priority based on p_estcpu & ps_nice */
387 	u_int	p_estcpu;		/* [S] Time averaged val of p_cpticks */
388 	int	p_pledge_syscall;	/* Cache of current syscall */
389 
390 	struct	ucred *p_ucred;		/* [o] cached credentials */
391 	struct	sigaltstack p_sigstk;	/* sp & on stack state variable */
392 
393 	u_long	p_prof_addr;	/* tmp storage for profiling addr until AST */
394 	u_long	p_prof_ticks;	/* tmp storage for profiling ticks until AST */
395 
396 /* End area that is copied on creation. */
397 #define	p_endcopy	p_addr
398 	struct	user *p_addr;	/* Kernel virtual addr of u-area */
399 	struct	mdproc p_md;	/* Any machine-dependent fields. */
400 
401 	sigset_t p_oldmask;	/* [o] Saved mask from before sigpause */
402 	int	p_sisig;	/* For core dump/debugger XXX */
403 	union sigval p_sigval;	/* For core dump/debugger XXX */
404 	long	p_sitrapno;	/* For core dump/debugger XXX */
405 	int	p_sicode;	/* For core dump/debugger XXX */
406 };
407 
408 /* Status values. */
409 #define	SIDL	1		/* Thread being created by fork. */
410 #define	SRUN	2		/* Currently runnable. */
411 #define	SSLEEP	3		/* Sleeping on an address. */
412 #define	SSTOP	4		/* Debugging or suspension. */
413 #define	SZOMB	5		/* unused */
414 #define	SDEAD	6		/* Thread is almost gone */
415 #define	SONPROC	7		/* Thread is currently on a CPU. */
416 
417 #define	P_ZOMBIE(p)	((p)->p_stat == SDEAD)
418 #define	P_HASSIBLING(p)	((p)->p_p->ps_threadcnt > 1)
419 
420 /*
421  * These flags are per-thread and kept in p_flag
422  */
423 #define	P_INKTR		0x00000001	/* In a ktrace op, don't recurse */
424 #define	P_PROFPEND	0x00000002	/* SIGPROF needs to be posted */
425 #define	P_ALRMPEND	0x00000004	/* SIGVTALRM needs to be posted */
426 #define	P_SIGSUSPEND	0x00000008	/* Need to restore before-suspend mask*/
427 #define	P_CANTSLEEP	0x00000010	/* insomniac thread */
428 #define	P_WSLEEP	0x00000020	/* Working on going to sleep. */
429 #define	P_SINTR		0x00000080	/* Sleep is interruptible. */
430 #define	P_SYSTEM	0x00000200	/* No sigs, stats or swapping. */
431 #define	P_TIMEOUT	0x00000400	/* Timing out during sleep. */
432 #define	P_WEXIT		0x00002000	/* Working on exiting. */
433 #define	P_OWEUPC	0x00008000	/* Owe proc an addupc() at next ast. */
434 #define	P_SUSPSINGLE	0x00080000	/* Need to stop for single threading. */
435 #define P_CONTINUED	0x00800000	/* Proc has continued from a stopped state. */
436 #define	P_THREAD	0x04000000	/* Only a thread, not a real process */
437 #define	P_SUSPSIG	0x08000000	/* Stopped from signal. */
438 #define P_CPUPEG	0x40000000	/* Do not move to another cpu. */
439 
440 #define	P_BITS \
441     ("\20" "\01INKTR" "\02PROFPEND" "\03ALRMPEND" "\04SIGSUSPEND" \
442      "\05CANTSLEEP" "\06WSLEEP" "\010SINTR" "\012SYSTEM" "\013TIMEOUT" \
443      "\016WEXIT" "\020OWEUPC" "\024SUSPSINGLE" "\027XX" \
444      "\030CONTINUED" "\033THREAD" "\034SUSPSIG" "\035SOFTDEP" "\037CPUPEG")
445 
446 #define	THREAD_PID_OFFSET	100000
447 
448 #ifdef _KERNEL
449 
450 struct uidinfo {
451 	LIST_ENTRY(uidinfo) ui_hash;	/* [U] */
452 	uid_t   ui_uid;			/* [I] */
453 	long    ui_proccnt;		/* [U] proc structs */
454 	long	ui_lockcnt;		/* [U] lockf structs */
455 };
456 
457 struct uidinfo *uid_find(uid_t);
458 void uid_release(struct uidinfo *);
459 
460 /*
461  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
462  * as it is used to represent "no process group".
463  * We set PID_MAX to 99999 to keep it in 5 columns in ps
464  * When exposed to userspace, thread IDs have THREAD_PID_OFFSET
465  * added to keep them from overlapping the PID range.  For them,
466  * we use a * a (0 .. 2^n] range for cheapness, picking 'n' such
467  * that 2^n + THREAD_PID_OFFSET and THREAD_PID_OFFSET have
468  * the same number of columns when printed.
469  */
470 #define	PID_MAX			99999
471 #define	TID_MASK		0x7ffff
472 
473 #define	NO_PID		(PID_MAX+1)
474 
475 #define SESS_LEADER(pr)	((pr)->ps_session->s_leader == (pr))
476 #define	SESSHOLD(s)	((s)->s_count++)
477 #define	SESSRELE(s) do {						\
478 	if (--(s)->s_count == 0) {					\
479 		timeout_del(&(s)->s_verauthto);			\
480 		pool_put(&session_pool, (s));				\
481 	}								\
482 } while (/* CONSTCOND */ 0)
483 
484 /*
485  * Flags to fork1().
486  */
487 #define FORK_FORK	0x00000001
488 #define FORK_VFORK	0x00000002
489 #define FORK_IDLE	0x00000004
490 #define FORK_PPWAIT	0x00000008
491 #define FORK_SHAREFILES	0x00000010
492 #define FORK_SYSTEM	0x00000020
493 #define FORK_NOZOMBIE	0x00000040
494 #define FORK_SHAREVM	0x00000080
495 #define FORK_PTRACE	0x00000400
496 
497 #define EXIT_NORMAL		0x00000001
498 #define EXIT_THREAD		0x00000002
499 #define EXIT_THREAD_NOCHECK	0x00000003
500 
501 #define	TIDHASH(tid)	(&tidhashtbl[(tid) & tidhash])
502 extern LIST_HEAD(tidhashhead, proc) *tidhashtbl;
503 extern u_long tidhash;
504 
505 #define	PIDHASH(pid)	(&pidhashtbl[(pid) & pidhash])
506 extern LIST_HEAD(pidhashhead, process) *pidhashtbl;
507 extern u_long pidhash;
508 
509 #define	PGRPHASH(pgid)	(&pgrphashtbl[(pgid) & pgrphash])
510 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
511 extern u_long pgrphash;
512 
513 extern struct proc proc0;		/* Process slot for swapper. */
514 extern struct process process0;		/* Process slot for kernel threads. */
515 extern int nprocesses, maxprocess;	/* Cur and max number of processes. */
516 extern int nthreads, maxthread;		/* Cur and max number of threads. */
517 
518 LIST_HEAD(proclist, proc);
519 LIST_HEAD(processlist, process);
520 extern struct processlist allprocess;	/* List of all processes. */
521 extern struct processlist zombprocess;	/* List of zombie processes. */
522 extern struct proclist allproc;		/* List of all threads. */
523 
524 extern struct process *initprocess;	/* Process slot for init. */
525 extern struct proc *reaperproc;		/* Thread slot for reaper. */
526 extern struct proc *syncerproc;		/* filesystem syncer daemon */
527 
528 extern struct pool process_pool;	/* memory pool for processes */
529 extern struct pool proc_pool;		/* memory pool for procs */
530 extern struct pool rusage_pool;		/* memory pool for zombies */
531 extern struct pool ucred_pool;		/* memory pool for ucreds */
532 extern struct pool session_pool;	/* memory pool for sessions */
533 extern struct pool pgrp_pool;		/* memory pool for pgrps */
534 
535 void	freepid(pid_t);
536 
537 struct process *prfind(pid_t);	/* Find process by id. */
538 struct process *zombiefind(pid_t); /* Find zombie process by id. */
539 struct proc *tfind(pid_t);	/* Find thread by id. */
540 struct pgrp *pgfind(pid_t);	/* Find process group by id. */
541 struct proc *tfind_user(pid_t, struct process *);
542 				/* Find thread by userspace id. */
543 void	proc_printit(struct proc *p, const char *modif,
544     int (*pr)(const char *, ...));
545 
546 int	chgproccnt(uid_t uid, int diff);
547 void	enternewpgrp(struct process *, struct pgrp *, struct session *);
548 void	enterthispgrp(struct process *, struct pgrp *);
549 int	inferior(struct process *, struct process *);
550 void	leavepgrp(struct process *);
551 void	killjobc(struct process *);
552 void	preempt(void);
553 void	procinit(void);
554 void	setpriority(struct proc *, uint32_t, uint8_t);
555 void	setrunnable(struct proc *);
556 void	endtsleep(void *);
557 int	wakeup_proc(struct proc *, int);
558 void	unsleep(struct proc *);
559 void	reaper(void *);
560 __dead void exit1(struct proc *, int, int, int);
561 void	exit2(struct proc *);
562 void	cpu_fork(struct proc *_curp, struct proc *_child, void *_stack,
563 	    void *_tcb, void (*_func)(void *), void *_arg);
564 void	cpu_exit(struct proc *);
565 void	process_initialize(struct process *, struct proc *);
566 int	fork1(struct proc *_curp, int _flags, void (*_func)(void *),
567 	    void *_arg, register_t *_retval, struct proc **_newprocp);
568 int	thread_fork(struct proc *_curp, void *_stack, void *_tcb,
569 	    pid_t *_tidptr, register_t *_retval);
570 int	groupmember(gid_t, struct ucred *);
571 void	dorefreshcreds(struct process *, struct proc *);
572 void	dosigsuspend(struct proc *, sigset_t);
573 
574 static inline void
refreshcreds(struct proc * p)575 refreshcreds(struct proc *p)
576 {
577 	struct process *pr = p->p_p;
578 
579 	/* this is an unlocked access to ps_ucred, but the result is benign */
580 	if (pr->ps_ucred != p->p_ucred)
581 		dorefreshcreds(pr, p);
582 }
583 
584 #define	SINGLE_SUSPEND	0x01	/* other threads to stop wherever they are */
585 #define	SINGLE_UNWIND	0x02	/* other threads to unwind and stop */
586 #define	SINGLE_EXIT	0x03	/* other threads to unwind and then exit */
587 #define	SINGLE_MASK	0x0f
588 /* extra flags for single_thread_set */
589 #define	SINGLE_DEEP	0x10	/* call is in deep */
590 #define	SINGLE_NOWAIT	0x20	/* do not wait for other threads to stop */
591 
592 int	single_thread_set(struct proc *, int);
593 int	single_thread_wait(struct process *, int);
594 void	single_thread_clear(struct proc *, int);
595 int	single_thread_check(struct proc *, int);
596 
597 void	child_return(void *);
598 
599 int	proc_cansugid(struct proc *);
600 
601 struct cond {
602 	unsigned int	c_wait;		/* [a] initialized and waiting */
603 };
604 
605 #define COND_INITIALIZER()		{ .c_wait = 1 }
606 
607 void	proc_trampoline_mi(void);
608 
609 /*
610  * functions to handle sets of cpus.
611  *
612  * For now we keep the cpus in ints so that we can use the generic
613  * atomic ops.
614  */
615 #define CPUSET_ASIZE(x) (((x) - 1)/32 + 1)
616 #define CPUSET_SSIZE CPUSET_ASIZE(MAXCPUS)
617 struct cpuset {
618 	int cs_set[CPUSET_SSIZE];
619 };
620 
621 void cpuset_init_cpu(struct cpu_info *);
622 
623 void cpuset_clear(struct cpuset *);
624 void cpuset_add(struct cpuset *, struct cpu_info *);
625 void cpuset_del(struct cpuset *, struct cpu_info *);
626 int cpuset_isset(struct cpuset *, struct cpu_info *);
627 void cpuset_add_all(struct cpuset *);
628 void cpuset_copy(struct cpuset *, struct cpuset *);
629 void cpuset_union(struct cpuset *, struct cpuset *, struct cpuset *);
630 void cpuset_intersection(struct cpuset *t, struct cpuset *, struct cpuset *);
631 void cpuset_complement(struct cpuset *, struct cpuset *, struct cpuset *);
632 int cpuset_cardinality(struct cpuset *);
633 struct cpu_info *cpuset_first(struct cpuset *);
634 
635 #endif	/* _KERNEL */
636 #endif	/* !_SYS_PROC_H_ */
637 
638