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