xref: /illumos-gate/usr/src/uts/common/sys/proc.h (revision 4c28a617e3922d92a58e813a5b955eb526b9c386)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2018 Joyent, Inc.
25  */
26 
27 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
28 /*	  All Rights Reserved	*/
29 
30 #ifndef _SYS_PROC_H
31 #define	_SYS_PROC_H
32 
33 #include <sys/time.h>
34 #include <sys/thread.h>
35 #include <sys/cred.h>
36 #include <sys/user.h>
37 #include <sys/watchpoint.h>
38 #include <sys/timer.h>
39 #if defined(__x86)
40 #include <sys/tss.h>
41 #include <sys/segments.h>
42 #endif
43 #include <sys/utrap.h>
44 #include <sys/model.h>
45 #include <sys/refstr.h>
46 #include <sys/avl.h>
47 #include <sys/rctl.h>
48 #include <sys/list.h>
49 #include <sys/avl.h>
50 #include <sys/door_impl.h>
51 #include <sys/signalfd.h>
52 #include <sys/secflags.h>
53 
54 #ifdef	__cplusplus
55 extern "C" {
56 #endif
57 
58 /*
59  * Profile arguments.
60  */
61 struct prof {
62 	void		*pr_base;	/* buffer base */
63 	uintptr_t	pr_off;		/* pc offset */
64 	size_t		pr_size;	/* buffer size */
65 	uint32_t	pr_scale;	/* pc scaling */
66 	long		pr_samples;	/* sample count */
67 };
68 
69 /*
70  * An lwp directory entry.
71  * If le_thread != NULL, this is an active lwp.
72  * If le_thread == NULL, this is an unreaped zombie lwp.
73  */
74 typedef struct lwpent {
75 	kthread_t	*le_thread;	/* the active lwp, NULL if zombie */
76 	id_t		le_lwpid;	/* its lwpid (t->t_tid) */
77 	uint16_t	le_waiters;	/* total number of lwp_wait()ers */
78 	uint16_t	le_dwaiters;	/* number that are daemons */
79 	clock_t		le_start;	/* start time of this lwp */
80 	struct vnode	*le_trace;	/* pointer to /proc lwp vnode */
81 } lwpent_t;
82 
83 typedef struct pctxop {
84 	void	(*save_op)(void *);	/* function to invoke to save ctx */
85 	void	(*restore_op)(void *);	/* function to invoke to restore ctx */
86 	void	(*fork_op)(void *, void *); /* invoke to fork context */
87 	void	(*exit_op)(void *);	/* invoked during process exit */
88 	void	(*free_op)(void *, int); /* function which frees the context */
89 	void	*arg;			/* argument to above functions */
90 	struct pctxop *next;		/* next pcontext ops */
91 } pctxop_t;
92 
93 /*
94  * Elements of the lwp directory, p->p_lwpdir[].
95  *
96  * We allocate lwp directory entries separately from lwp directory
97  * elements because the lwp directory must be allocated as an array.
98  * The number of lwps can grow quite large and we want to keep the
99  * size of the kmem_alloc()d directory as small as possible.
100  *
101  * If ld_entry == NULL, the entry is free and is on the free list,
102  * p->p_lwpfree, linked through ld_next.  If ld_entry != NULL, the
103  * entry is used and ld_next is the thread-id hash link pointer.
104  */
105 typedef struct lwpdir {
106 	struct lwpdir	*ld_next;	/* hash chain or free list */
107 	struct lwpent	*ld_entry;	/* lwp directory entry */
108 } lwpdir_t;
109 
110 /*
111  * Element of the p_tidhash thread-id (lwpid) hash table.
112  */
113 typedef struct tidhash {
114 	kmutex_t	th_lock;
115 	lwpdir_t	*th_list;
116 } tidhash_t;
117 
118 /*
119  * Retired tidhash hash tables.
120  */
121 typedef struct ret_tidhash {
122 	struct ret_tidhash	*rth_next;
123 	tidhash_t		*rth_tidhash;
124 	uint_t			rth_tidhash_sz;
125 } ret_tidhash_t;
126 
127 struct pool;
128 struct task;
129 struct zone;
130 struct brand;
131 struct corectl_path;
132 struct corectl_content;
133 
134 /*
135  * One structure allocated per active process.  It contains all
136  * data needed about the process while the process may be swapped
137  * out.  Other per-process data (user.h) is also inside the proc structure.
138  * Lightweight-process data (lwp.h) and the kernel stack may be swapped out.
139  */
140 typedef struct	proc {
141 	/*
142 	 * Fields requiring no explicit locking
143 	 */
144 	struct	vnode *p_exec;		/* pointer to a.out vnode */
145 	struct	as *p_as;		/* process address space pointer */
146 	struct	plock *p_lockp;		/* ptr to proc struct's mutex lock */
147 	kmutex_t p_crlock;		/* lock for p_cred */
148 	struct	cred	*p_cred;	/* process credentials */
149 	/*
150 	 * Fields protected by pidlock
151 	 */
152 	int	p_swapcnt;		/* number of swapped out lwps */
153 	char	p_stat;			/* status of process */
154 	char	p_wcode;		/* current wait code */
155 	ushort_t p_pidflag;		/* flags protected only by pidlock */
156 	int 	p_wdata;		/* current wait return value */
157 	pid_t	p_ppid;			/* process id of parent */
158 	struct	proc	*p_link;	/* forward link */
159 	struct	proc	*p_parent;	/* ptr to parent process */
160 	struct	proc	*p_child;	/* ptr to first child process */
161 	struct	proc	*p_sibling;	/* ptr to next sibling proc on chain */
162 	struct	proc	*p_psibling;	/* ptr to prev sibling proc on chain */
163 	struct	proc	*p_sibling_ns;	/* prt to siblings with new state */
164 	struct	proc	*p_child_ns;	/* prt to children with new state */
165 	struct	proc 	*p_next;	/* active chain link next */
166 	struct	proc 	*p_prev;	/* active chain link prev */
167 	struct	proc 	*p_nextofkin;	/* gets accounting info at exit */
168 	struct	proc 	*p_orphan;
169 	struct	proc 	*p_nextorph;
170 	struct	proc	*p_pglink;	/* process group hash chain link next */
171 	struct	proc	*p_ppglink;	/* process group hash chain link prev */
172 	struct	sess	*p_sessp;	/* session information */
173 	struct	pid 	*p_pidp;	/* process ID info */
174 	struct	pid 	*p_pgidp;	/* process group ID info */
175 	/*
176 	 * Fields protected by p_lock
177 	 */
178 	kcondvar_t p_cv;		/* proc struct's condition variable */
179 	kcondvar_t p_flag_cv;
180 	kcondvar_t p_lwpexit;		/* waiting for some lwp to exit */
181 	kcondvar_t p_holdlwps;		/* process is waiting for its lwps */
182 					/* to to be held.  */
183 	uint_t	p_proc_flag;		/* /proc-related flags */
184 	uint_t	p_flag;			/* protected while set. */
185 					/* flags defined below */
186 	clock_t	p_utime;		/* user time, this process */
187 	clock_t	p_stime;		/* system time, this process */
188 	clock_t	p_cutime;		/* sum of children's user time */
189 	clock_t	p_cstime;		/* sum of children's system time */
190 	avl_tree_t *p_segacct;		/* System V shared segment list */
191 	avl_tree_t *p_semacct;		/* System V semaphore undo list */
192 	caddr_t	p_bssbase;		/* base addr of last bss below heap */
193 	caddr_t	p_brkbase;		/* base addr of heap */
194 	size_t	p_brksize;		/* heap size in bytes */
195 	uint_t	p_brkpageszc;		/* preferred heap max page size code */
196 	/*
197 	 * Per process signal stuff.
198 	 */
199 	k_sigset_t p_sig;		/* signals pending to this process */
200 	k_sigset_t p_extsig;		/* signals sent from another contract */
201 	k_sigset_t p_ignore;		/* ignore when generated */
202 	k_sigset_t p_siginfo;		/* gets signal info with signal */
203 	void *p_sigfd;			/* signalfd support state */
204 	struct sigqueue *p_sigqueue;	/* queued siginfo structures */
205 	struct sigqhdr *p_sigqhdr;	/* hdr to sigqueue structure pool */
206 	struct sigqhdr *p_signhdr;	/* hdr to signotify structure pool */
207 	uchar_t	p_stopsig;		/* jobcontrol stop signal */
208 
209 	/*
210 	 * Special per-process flag when set will fix misaligned memory
211 	 * references.
212 	 */
213 	char    p_fixalignment;
214 
215 	/*
216 	 * Per process lwp and kernel thread stuff
217 	 */
218 	id_t	p_lwpid;		/* most recently allocated lwpid */
219 	int 	p_lwpcnt;		/* number of lwps in this process */
220 	int	p_lwprcnt;		/* number of not stopped lwps */
221 	int	p_lwpdaemon;		/* number of TP_DAEMON lwps */
222 	int	p_lwpwait;		/* number of lwps in lwp_wait() */
223 	int	p_lwpdwait;		/* number of daemons in lwp_wait() */
224 	int	p_zombcnt;		/* number of zombie lwps */
225 	kthread_t *p_tlist;		/* circular list of threads */
226 	lwpdir_t *p_lwpdir;		/* thread (lwp) directory */
227 	lwpdir_t *p_lwpfree;		/* p_lwpdir free list */
228 	tidhash_t *p_tidhash;		/* tid (lwpid) lookup hash table */
229 	uint_t	p_lwpdir_sz;		/* number of p_lwpdir[] entries */
230 	uint_t	p_tidhash_sz;		/* number of p_tidhash[] entries */
231 	ret_tidhash_t *p_ret_tidhash;	/* retired tidhash hash tables */
232 	uint64_t p_lgrpset;		/* unprotected hint of set of lgrps */
233 					/* on which process has threads */
234 	volatile lgrp_id_t  p_t1_lgrpid; /* main's thread lgroup id */
235 	volatile lgrp_id_t  p_tr_lgrpid; /* text replica's lgroup id */
236 #if defined(_LP64)
237 	uintptr_t  p_lgrpres2;		/* reserved for lgrp migration */
238 #endif
239 	/*
240 	 * /proc (process filesystem) debugger interface stuff.
241 	 */
242 	k_sigset_t p_sigmask;		/* mask of traced signals (/proc) */
243 	k_fltset_t p_fltmask;		/* mask of traced faults (/proc) */
244 	struct vnode *p_trace;		/* pointer to primary /proc vnode */
245 	struct vnode *p_plist;		/* list of /proc vnodes for process */
246 	kthread_t *p_agenttp;		/* thread ptr for /proc agent lwp */
247 	avl_tree_t p_warea;		/* list of watched areas */
248 	avl_tree_t p_wpage;		/* remembered watched pages (vfork) */
249 	watched_page_t *p_wprot;	/* pages that need to have prot set */
250 	int	p_mapcnt;		/* number of active pr_mappage()s */
251 	kmutex_t p_maplock;		/* lock for pr_mappage() */
252 	struct	proc  *p_rlink;		/* linked list for server */
253 	kcondvar_t p_srwchan_cv;
254 	size_t	p_stksize;		/* process stack size in bytes */
255 	uint_t	p_stkpageszc;		/* preferred stack max page size code */
256 
257 	/*
258 	 * Microstate accounting, resource usage, and real-time profiling
259 	 */
260 	hrtime_t p_mstart;		/* hi-res process start time */
261 	hrtime_t p_mterm;		/* hi-res process termination time */
262 	hrtime_t p_mlreal;		/* elapsed time sum over defunct lwps */
263 	hrtime_t p_acct[NMSTATES];	/* microstate sum over defunct lwps */
264 	hrtime_t p_cacct[NMSTATES];	/* microstate sum over child procs */
265 	struct lrusage p_ru;		/* lrusage sum over defunct lwps */
266 	struct lrusage p_cru;		/* lrusage sum over child procs */
267 	struct itimerval p_rprof_timer; /* ITIMER_REALPROF interval timer */
268 	uintptr_t p_rprof_cyclic;	/* ITIMER_REALPROF cyclic */
269 	uint_t	p_defunct;		/* number of defunct lwps */
270 	/*
271 	 * profiling. A lock is used in the event of multiple lwp's
272 	 * using the same profiling base/size.
273 	 */
274 	kmutex_t p_pflock;		/* protects user profile arguments */
275 	struct prof p_prof;		/* profile arguments */
276 
277 	/*
278 	 * Doors.
279 	 */
280 	door_pool_t		p_server_threads; /* common thread pool */
281 	struct door_node	*p_door_list;	/* active doors */
282 	struct door_node	*p_unref_list;
283 	kcondvar_t		p_unref_cv;
284 	char			p_unref_thread;	/* unref thread created */
285 
286 	/*
287 	 * Kernel probes
288 	 */
289 	uchar_t			p_tnf_flags;
290 
291 	/*
292 	 * Solaris Audit
293 	 */
294 	struct p_audit_data	*p_audit_data; /* per process audit structure */
295 
296 	pctxop_t	*p_pctx;
297 
298 #if defined(__x86)
299 	/*
300 	 * LDT support.
301 	 */
302 	kmutex_t	p_ldtlock;	/* protects the following fields */
303 	user_desc_t	*p_ldt;		/* Pointer to private LDT */
304 	uint64_t	p_unused1;	/* no longer used */
305 	uint64_t	p_unused2;	/* no longer used */
306 	ushort_t	p_ldtlimit;	/* highest selector used */
307 #endif
308 	size_t p_swrss;			/* resident set size before last swap */
309 	struct aio	*p_aio;		/* pointer to async I/O struct */
310 	struct itimer	**p_itimer;	/* interval timers */
311 	timeout_id_t	p_alarmid;	/* alarm's timeout id */
312 	caddr_t		p_usrstack;	/* top of the process stack */
313 	uint_t		p_stkprot;	/* stack memory protection */
314 	uint_t		p_datprot;	/* data memory protection */
315 	model_t		p_model;	/* data model determined at exec time */
316 	struct lwpchan_data *p_lcp;	/* lwpchan cache */
317 	kmutex_t	p_lcp_lock;	/* protects assignments to p_lcp */
318 	utrap_handler_t	*p_utraps;	/* pointer to user trap handlers */
319 	struct corectl_path	*p_corefile;	/* pattern for core file */
320 	struct task	*p_task;	/* our containing task */
321 	struct proc	*p_taskprev;	/* ptr to previous process in task */
322 	struct proc	*p_tasknext;	/* ptr to next process in task */
323 	kmutex_t	p_sc_lock;	/* protects p_pagep */
324 	struct sc_page_ctl *p_pagep;	/* list of process's shared pages */
325 	struct rctl_set	*p_rctls;	/* resource controls for this process */
326 	rlim64_t	p_stk_ctl;	/* currently enforced stack size */
327 	rlim64_t	p_fsz_ctl;	/* currently enforced file size */
328 	rlim64_t	p_vmem_ctl;	/* currently enforced addr-space size */
329 	rlim64_t	p_fno_ctl;	/* currently enforced file-desc limit */
330 	pid_t		p_ancpid;	/* ancestor pid, used by exacct */
331 	struct itimerval p_realitimer;	/* real interval timer */
332 	timeout_id_t	p_itimerid;	/* real interval timer's timeout id */
333 	struct corectl_content *p_content;	/* content of core file */
334 
335 	avl_tree_t	p_ct_held;	/* held contracts */
336 	struct ct_equeue **p_ct_equeue;	/* process-type event queues */
337 
338 	struct cont_process *p_ct_process; /* process contract */
339 	list_node_t	p_ct_member;	/* process contract membership */
340 	sigqueue_t	*p_killsqp;	/* sigqueue pointer for SIGKILL */
341 
342 	int		p_dtrace_probes; /* are there probes for this proc? */
343 	uint64_t	p_dtrace_count;	/* number of DTrace tracepoints */
344 					/* (protected by P_PR_LOCK) */
345 	void		*p_dtrace_helpers; /* DTrace helpers, if any */
346 	struct pool	*p_pool;	/* pointer to containing pool */
347 	kcondvar_t	p_poolcv;	/* synchronization with pools */
348 	uint_t		p_poolcnt;	/* # threads inside pool barrier */
349 	uint_t		p_poolflag;	/* pool-related flags (see below) */
350 	uintptr_t	p_portcnt;	/* event ports counter */
351 	struct zone	*p_zone;	/* zone in which process lives */
352 	struct vnode	*p_execdir;	/* directory that p_exec came from */
353 	struct brand	*p_brand;	/* process's brand  */
354 	void		*p_brand_data;	/* per-process brand state */
355 	psecflags_t	p_secflags;	/* per-process security flags */
356 
357 	/* additional lock to protect p_sessp (but not its contents) */
358 	kmutex_t p_splock;
359 	rctl_qty_t	p_locked_mem;	/* locked memory charged to proc */
360 					/* protected by p_lock */
361 	rctl_qty_t	p_crypto_mem;	/* /dev/crypto memory charged to proc */
362 					/* protected by p_lock */
363 	clock_t	p_ttime;		/* buffered task time */
364 
365 	/*
366 	 * The user structure
367 	 */
368 	struct user p_user;		/* (see sys/user.h) */
369 } proc_t;
370 
371 #define	PROC_T				/* headers relying on proc_t are OK */
372 
373 #ifdef _KERNEL
374 
375 /* active process chain */
376 
377 extern proc_t *practive;
378 
379 /* Well known processes */
380 
381 extern proc_t *proc_sched;		/* memory scheduler */
382 extern proc_t *proc_init;		/* init */
383 extern proc_t *proc_pageout;		/* pageout daemon */
384 extern proc_t *proc_fsflush;		/* filesystem sync-er */
385 
386 #endif /* _KERNEL */
387 
388 /*
389  * Stuff to keep track of the number of processes each uid has.
390  * It is tracked on a per-zone basis; that is, if users in different
391  * zones have the same uid, they are tracked separately.
392  *
393  * A structure is allocated when a new <uid,zoneid> pair shows up
394  * There is a hash to find each structure.
395  */
396 struct	upcount	{
397 	struct	upcount	*up_next;
398 	uid_t		up_uid;
399 	zoneid_t	up_zoneid;
400 	uint_t		up_count;
401 };
402 
403 /* process ID info */
404 
405 struct pid {
406 	unsigned int pid_prinactive :1;
407 	unsigned int pid_pgorphaned :1;
408 	unsigned int pid_padding :6;	/* used to be pid_ref, now an int */
409 	unsigned int pid_prslot :24;
410 	pid_t pid_id;
411 	struct proc *pid_pglink;
412 	struct proc *pid_pgtail;
413 	struct pid *pid_link;
414 	uint_t pid_ref;
415 };
416 
417 #define	p_pgrp p_pgidp->pid_id
418 #define	p_pid  p_pidp->pid_id
419 #define	p_slot p_pidp->pid_prslot
420 #define	p_detached p_pgidp->pid_pgorphaned
421 
422 #define	PID_HOLD(pidp)	ASSERT(MUTEX_HELD(&pidlock)); \
423 			++(pidp)->pid_ref;
424 #define	PID_RELE(pidp)	ASSERT(MUTEX_HELD(&pidlock)); \
425 			(pidp)->pid_ref > 1 ? \
426 				--(pidp)->pid_ref : pid_rele(pidp);
427 
428 /*
429  * Structure containing persistent process lock.  The structure and
430  * macro allow "mutex_enter(&p->p_lock)" to continue working.
431  */
432 struct plock {
433 	kmutex_t pl_lock;
434 };
435 #define	p_lock	p_lockp->pl_lock
436 
437 #ifdef _KERNEL
438 extern proc_t p0;		/* process 0 */
439 extern struct plock p0lock;	/* p0's plock */
440 extern struct pid pid0;		/* p0's pid */
441 
442 /* pid_allocate() flags */
443 #define	PID_ALLOC_PROC	0x0001	/* assign a /proc slot as well */
444 
445 #endif /* _KERNEL */
446 
447 /* stat codes */
448 
449 #define	SSLEEP	1		/* awaiting an event */
450 #define	SRUN	2		/* runnable */
451 #define	SZOMB	3		/* process terminated but not waited for */
452 #define	SSTOP	4		/* process stopped by debugger */
453 #define	SIDL	5		/* intermediate state in process creation */
454 #define	SONPROC	6		/* process is being run on a processor */
455 #define	SWAIT	7		/* process is waiting to become runnable */
456 
457 /* p_pidflag codes */
458 #define	CLDPEND		0x0001	/* have yet to post a SIGCHLD to the parent */
459 #define	CLDCONT		0x0002	/* child has notified parent of CLD_CONTINUED */
460 #define	CLDNOSIGCHLD	0x0004	/* do not post SIGCHLD when child terminates */
461 #define	CLDWAITPID	0x0008	/* only waitid(P_PID, pid) can reap the child */
462 
463 /* p_proc_flag codes -- these flags are mostly private to /proc */
464 #define	P_PR_TRACE	0x0001	/* signal, fault or syscall tracing via /proc */
465 #define	P_PR_PTRACE	0x0002	/* ptrace() compatibility mode */
466 #define	P_PR_FORK	0x0004	/* child inherits tracing flags */
467 #define	P_PR_LOCK	0x0008	/* process locked by /proc */
468 #define	P_PR_ASYNC	0x0010	/* asynchronous stopping via /proc */
469 #define	P_PR_EXEC	0x0020	/* process is in exec() */
470 #define	P_PR_BPTADJ	0x0040	/* adjust pc on breakpoint trap */
471 #define	P_PR_RUNLCL	0x0080	/* set process running on last /proc close */
472 #define	P_PR_KILLCL	0x0100	/* kill process on last /proc close */
473 
474 /*
475  * p_flag codes
476  *
477  * note that two of these flags, SMSACCT and SSYS, are exported to /proc's
478  * psinfo_t.p_flag field.  Historically, all were, but since they are
479  * implementation dependant, we only export the ones people have come to
480  * rely upon.  Hence, the bit positions of SSYS and SMSACCT should not be
481  * altered.
482  */
483 #define	SSYS	   0x00000001	/* system (resident) process */
484 #define	SEXITING   0x00000002	/* process is exiting */
485 #define	SITBUSY	   0x00000004	/* setitimer(ITIMER_REAL) in progress */
486 #define	SFORKING   0x00000008	/* tells called functions that we're forking */
487 #define	SWATCHOK   0x00000010	/* proc in acceptable state for watchpoints */
488 #define	SKILLED    0x00000100	/* SIGKILL has been posted to the process */
489 #define	SSCONT	   0x00000200	/* SIGCONT has been posted to the process */
490 #define	SZONETOP   0x00000400	/* process has no valid PPID in its zone */
491 #define	SEXTKILLED 0x00000800	/* SKILLED is from another contract */
492 #define	SUGID	   0x00002000	/* process was result of set[ug]id exec */
493 #define	SEXECED	   0x00004000	/* this process has execed */
494 #define	SJCTL	   0x00010000	/* SIGCHLD sent when children stop/continue */
495 #define	SNOWAIT    0x00020000	/* children never become zombies */
496 #define	SVFORK	   0x00040000	/* child of vfork that has not yet exec'd */
497 #define	SVFWAIT	   0x00080000	/* parent of vfork waiting for child to exec */
498 #define	SEXITLWPS  0x00100000	/* have lwps exit within the process */
499 #define	SHOLDFORK  0x00200000	/* hold lwps where they're cloneable */
500 #define	SHOLDFORK1 0x00800000	/* hold lwps in place (not cloning) */
501 #define	SCOREDUMP  0x01000000	/* process is dumping core */
502 #define	SMSACCT    0x02000000	/* process is keeping micro-state accounting */
503 #define	SLWPWRAP   0x04000000	/* process has wrapped its lwp ids */
504 #define	SAUTOLPG   0x08000000	/* kernel controls page sizes */
505 #define	SNOCD	   0x10000000	/* new creds from VSxID, do not coredump */
506 #define	SHOLDWATCH 0x20000000	/* hold lwps for watchpoint operation */
507 #define	SMSFORK	   0x40000000	/* child inherits micro-state accounting */
508 #define	SDOCORE	   0x80000000	/* process will attempt to dump core */
509 
510 /*
511  * p_poolflag codes
512  *
513  * These flags are used to synchronize with the pool subsystem to allow
514  * re-binding of processes to new pools.
515  */
516 #define	PBWAIT		0x0001  /* process should wait outside fork/exec/exit */
517 #define	PEXITED		0x0002  /* process exited and about to become zombie */
518 
519 /* Macro to convert proc pointer to a user block pointer */
520 #define	PTOU(p)		(&(p)->p_user)
521 
522 #define	tracing(p, sig)	(sigismember(&(p)->p_sigmask, sig))
523 
524 /* Macro to reduce unnecessary calls to issig() */
525 
526 #define	ISSIG(t, why)	ISSIG_FAST(t, ttolwp(t), ttoproc(t), why)
527 
528 /*
529  * Fast version of ISSIG.
530  *	1. uses register pointers to lwp and proc instead of reloading them.
531  *	2. uses bit-wise OR of tests, since the usual case is that none of them
532  *	   are true, this saves orcc's and branches.
533  *	3. load the signal flags instead of using sigisempty() macro which does
534  *	   a branch to convert to boolean.
535  */
536 #define	ISSIG_FAST(t, lwp, p, why)		\
537 	(ISSIG_PENDING(t, lwp, p) && issig(why))
538 
539 #define	ISSIG_PENDING(t, lwp, p)		\
540 	((lwp)->lwp_cursig |			\
541 	    sigcheck((p), (t)) |		\
542 	    (p)->p_stopsig |			\
543 	    (t)->t_dtrace_stop |		\
544 	    (t)->t_dtrace_sig |			\
545 	    ((t)->t_proc_flag & (TP_PRSTOP|TP_HOLDLWP|TP_CHKPT|TP_PAUSE)) | \
546 	    ((p)->p_flag & (SEXITLWPS|SKILLED|SHOLDFORK1|SHOLDWATCH)))
547 
548 #define	ISSTOP(sig)	 (u.u_signal[sig-1] == SIG_DFL && \
549 				sigismember(&stopdefault, sig))
550 
551 #define	ISHOLD(p)	((p)->p_flag & SHOLDFORK)
552 
553 #define	MUSTRETURN(p, t)	(ISHOLD(p) | (t)->t_activefd.a_stale)
554 
555 /*
556  * Determine if there are any watchpoints active in the process.
557  */
558 #define	pr_watch_active(p)	(avl_numnodes(&(p)->p_warea) != 0)
559 
560 /* Reasons for calling issig() */
561 
562 #define	FORREAL		0	/* Usual side-effects */
563 #define	JUSTLOOKING	1	/* Don't stop the process */
564 
565 /* 'what' values for stop(PR_SUSPENDED, what) */
566 #define	SUSPEND_NORMAL	0
567 #define	SUSPEND_PAUSE	1
568 
569 /* pseudo-flag to lwp_create() */
570 #define	NOCLASS	(-1)
571 
572 /* unused scheduling class ID */
573 #define	CLASS_UNUSED	(-2)
574 
575 /* LWP stats updated via lwp_stats_update() */
576 typedef enum {
577 	LWP_STAT_INBLK,
578 	LWP_STAT_OUBLK,
579 	LWP_STAT_MSGRCV,
580 	LWP_STAT_MSGSND
581 } lwp_stat_id_t;
582 
583 typedef struct prkillinfo {
584 	int32_t prk_error;		/* errno */
585 	int32_t prk_pad;		/* pad */
586 	siginfo_t prk_info;		/* siginfo of killing signal */
587 } prkillinfo_t;
588 
589 #ifdef _KERNEL
590 
591 /* user profiling functions */
592 
593 extern void profil_tick(uintptr_t);
594 
595 /* process management functions */
596 
597 extern int newproc(void (*)(), caddr_t, id_t, int, struct contract **, pid_t);
598 extern void vfwait(pid_t);
599 extern void proc_detach(proc_t *);
600 extern void freeproc(proc_t *);
601 extern void setrun(kthread_t *);
602 extern void setrun_locked(kthread_t *);
603 extern void exit(int, int);
604 extern int proc_exit(int, int);
605 extern void proc_is_exiting(proc_t *);
606 extern void relvm(void);
607 extern void add_ns(proc_t *, proc_t *);
608 extern void delete_ns(proc_t *, proc_t *);
609 extern void upcount_inc(uid_t, zoneid_t);
610 extern void upcount_dec(uid_t, zoneid_t);
611 extern int upcount_get(uid_t, zoneid_t);
612 #if defined(__x86)
613 extern selector_t setup_thrptr(proc_t *, uintptr_t);
614 extern void deferred_singlestep_trap(caddr_t);
615 #endif
616 
617 extern void sigcld(proc_t *, sigqueue_t *);
618 extern void sigcld_delete(k_siginfo_t *);
619 extern void sigcld_repost(void);
620 extern int fsig(k_sigset_t *, kthread_t *);
621 extern void psig(void);
622 extern void stop(int, int);
623 extern int stop_on_fault(uint_t, k_siginfo_t *);
624 extern int issig(int);
625 extern int jobstopped(proc_t *);
626 extern void psignal(proc_t *, int);
627 extern void tsignal(kthread_t *, int);
628 extern void sigtoproc(proc_t *, kthread_t *, int);
629 extern void trapsig(k_siginfo_t *, int);
630 extern void realsigprof(int, int, int);
631 extern int eat_signal(kthread_t *, int);
632 extern int signal_is_blocked(kthread_t *, int);
633 extern int sigcheck(proc_t *, kthread_t *);
634 extern void sigdefault(proc_t *);
635 
636 extern void pid_setmin(void);
637 extern pid_t pid_allocate(proc_t *, pid_t, int);
638 extern int pid_rele(struct pid *);
639 extern void pid_exit(proc_t *, struct task *);
640 extern void proc_entry_free(struct pid *);
641 extern proc_t *prfind(pid_t);
642 extern proc_t *prfind_zone(pid_t, zoneid_t);
643 extern proc_t *pgfind(pid_t);
644 extern proc_t *pgfind_zone(pid_t, zoneid_t);
645 extern proc_t *sprlock(pid_t);
646 extern proc_t *sprlock_zone(pid_t, zoneid_t);
647 extern int sprtrylock_proc(proc_t *);
648 extern void sprwaitlock_proc(proc_t *);
649 extern void sprlock_proc(proc_t *);
650 extern void sprunlock(proc_t *);
651 extern void pid_init(void);
652 extern proc_t *pid_entry(int);
653 extern int pid_slot(proc_t *);
654 extern void signal(pid_t, int);
655 extern void prsignal(struct pid *, int);
656 extern int uread(proc_t *, void *, size_t, uintptr_t);
657 extern int uwrite(proc_t *, void *, size_t, uintptr_t);
658 
659 extern void pgsignal(struct pid *, int);
660 extern void pgjoin(proc_t *, struct pid *);
661 extern void pgcreate(proc_t *);
662 extern void pgexit(proc_t *);
663 extern void pgdetach(proc_t *);
664 extern int pgmembers(pid_t);
665 
666 extern	void	init_mstate(kthread_t *, int);
667 extern	int	new_mstate(kthread_t *, int);
668 extern	void	restore_mstate(kthread_t *);
669 extern	void	term_mstate(kthread_t *);
670 extern	void	estimate_msacct(kthread_t *, hrtime_t);
671 extern	void	disable_msacct(proc_t *);
672 extern	hrtime_t mstate_aggr_state(proc_t *, int);
673 extern	hrtime_t mstate_thread_onproc_time(kthread_t *);
674 extern	void	mstate_systhread_times(kthread_t *, hrtime_t *, hrtime_t *);
675 extern	void	syscall_mstate(int, int);
676 
677 extern	uint_t	cpu_update_pct(kthread_t *, hrtime_t);
678 
679 extern void	set_proc_pre_sys(proc_t *p);
680 extern void	set_proc_post_sys(proc_t *p);
681 extern void	set_proc_sys(proc_t *p);
682 extern void	set_proc_ast(proc_t *p);
683 extern void	set_all_proc_sys(void);
684 extern void	set_all_zone_usr_proc_sys(zoneid_t);
685 
686 /* thread function prototypes */
687 
688 extern	kthread_t	*thread_create(
689 	caddr_t		stk,
690 	size_t		stksize,
691 	void		(*proc)(),
692 	void		*arg,
693 	size_t		len,
694 	proc_t 		*pp,
695 	int		state,
696 	pri_t		pri);
697 extern	void	thread_exit(void) __NORETURN;
698 extern	void	thread_free(kthread_t *);
699 extern	void	thread_rele(kthread_t *);
700 extern	void	thread_join(kt_did_t);
701 extern	int	reaper(void);
702 extern	void	installctx(kthread_t *, void *, void (*)(), void (*)(),
703     void (*)(), void (*)(), void (*)(), void (*)());
704 extern	int	removectx(kthread_t *, void *, void (*)(), void (*)(),
705     void (*)(), void (*)(), void (*)(), void (*)());
706 extern	void	savectx(kthread_t *);
707 extern	void	restorectx(kthread_t *);
708 extern	void	forkctx(kthread_t *, kthread_t *);
709 extern	void	lwp_createctx(kthread_t *, kthread_t *);
710 extern	void	exitctx(kthread_t *);
711 extern	void	freectx(kthread_t *, int);
712 extern	void	installpctx(proc_t *, void *, void (*)(), void (*)(),
713     void (*)(), void (*)(), void (*)());
714 extern	int	removepctx(proc_t *, void *, void (*)(), void (*)(),
715     void (*)(), void (*)(), void (*)());
716 extern	void	savepctx(proc_t *);
717 extern	void	restorepctx(proc_t *);
718 extern	void	forkpctx(proc_t *, proc_t *);
719 extern	void	exitpctx(proc_t *);
720 extern	void	freepctx(proc_t *, int);
721 extern	kthread_t *thread_unpin(void);
722 extern	void	thread_init(void);
723 extern	void	thread_load(kthread_t *, void (*)(), caddr_t, size_t);
724 
725 extern	void	tsd_create(uint_t *, void (*)(void *));
726 extern	void	tsd_destroy(uint_t *);
727 extern	void	*tsd_getcreate(uint_t *, void (*)(void *), void *(*)(void));
728 extern	void	*tsd_get(uint_t);
729 extern	int	tsd_set(uint_t, void *);
730 extern	void	tsd_exit(void);
731 extern	void	*tsd_agent_get(kthread_t *, uint_t);
732 extern	int	tsd_agent_set(kthread_t *, uint_t, void *);
733 
734 /* lwp function prototypes */
735 
736 extern kthread_t *lwp_kernel_create(proc_t *, void (*)(), void *, int, pri_t);
737 extern	klwp_t 		*lwp_create(
738 	void		(*proc)(),
739 	caddr_t		arg,
740 	size_t		len,
741 	proc_t		*p,
742 	int		state,
743 	int		pri,
744 	const k_sigset_t *smask,
745 	int		cid,
746 	id_t		lwpid);
747 extern	kthread_t *idtot(proc_t *, id_t);
748 extern	void	lwp_hash_in(proc_t *, lwpent_t *, tidhash_t *, uint_t, int);
749 extern	void	lwp_hash_out(proc_t *, id_t);
750 extern	lwpdir_t *lwp_hash_lookup(proc_t *, id_t);
751 extern	lwpdir_t *lwp_hash_lookup_and_lock(proc_t *, id_t, kmutex_t **);
752 extern	void	lwp_create_done(kthread_t *);
753 extern	void	lwp_exit(void);
754 extern	void	lwp_pcb_exit(void);
755 extern	void	lwp_cleanup(void);
756 extern	int	lwp_suspend(kthread_t *);
757 extern	void	lwp_continue(kthread_t *);
758 extern	void	holdlwp(void);
759 extern	void	stoplwp(void);
760 extern	int	holdlwps(int);
761 extern	int	holdwatch(void);
762 extern	void	pokelwps(proc_t *);
763 extern	void	continuelwps(proc_t *);
764 extern	int	exitlwps(int);
765 extern	void	lwp_ctmpl_copy(klwp_t *, klwp_t *);
766 extern	void	lwp_ctmpl_clear(klwp_t *);
767 extern	klwp_t	*forklwp(klwp_t *, proc_t *, id_t);
768 extern	void	lwp_load(klwp_t *, gregset_t, uintptr_t);
769 extern	void	lwp_setrval(klwp_t *, int, int);
770 extern	void	lwp_forkregs(klwp_t *, klwp_t *);
771 extern	void	lwp_freeregs(klwp_t *, int);
772 extern	caddr_t	lwp_stk_init(klwp_t *, caddr_t);
773 extern	void	lwp_stk_cache_init(void);
774 extern	void	lwp_stk_fini(klwp_t *);
775 extern	void	lwp_fp_init(klwp_t *);
776 extern	void	lwp_installctx(klwp_t *);
777 extern	void	lwp_rtt(void);
778 extern	void	lwp_rtt_initial(void);
779 extern	int	lwp_setprivate(klwp_t *, int, uintptr_t);
780 extern	void	lwp_stat_update(lwp_stat_id_t, long);
781 extern	void	lwp_attach_brand_hdlrs(klwp_t *);
782 extern	void	lwp_detach_brand_hdlrs(klwp_t *);
783 
784 #if defined(__sparcv9)
785 extern	void	lwp_mmodel_newlwp(void);
786 extern	void	lwp_mmodel_shared_as(caddr_t, size_t);
787 #define	LWP_MMODEL_NEWLWP()		lwp_mmodel_newlwp()
788 #define	LWP_MMODEL_SHARED_AS(addr, sz)	lwp_mmodel_shared_as((addr), (sz))
789 #else
790 #define	LWP_MMODEL_NEWLWP()
791 #define	LWP_MMODEL_SHARED_AS(addr, sz)
792 #endif
793 
794 /*
795  * Signal queue function prototypes. Must be here due to header ordering
796  * dependencies.
797  */
798 extern void sigqfree(proc_t *);
799 extern void siginfofree(sigqueue_t *);
800 extern void sigdeq(proc_t *, kthread_t *, int, sigqueue_t **);
801 extern void sigdelq(proc_t *, kthread_t *, int);
802 extern void sigaddq(proc_t *, kthread_t *, k_siginfo_t *, int);
803 extern void sigaddqa(proc_t *, kthread_t *, sigqueue_t *);
804 extern void sigqsend(int, proc_t *, kthread_t *, sigqueue_t *);
805 extern void sigdupq(proc_t *, proc_t *);
806 extern int sigwillqueue(int, int);
807 extern sigqhdr_t *sigqhdralloc(size_t, uint_t);
808 extern sigqueue_t *sigqalloc(sigqhdr_t *);
809 extern void sigqhdrfree(sigqhdr_t *);
810 extern sigqueue_t *sigappend(k_sigset_t *, sigqueue_t *,
811 	k_sigset_t *, sigqueue_t *);
812 extern sigqueue_t *sigprepend(k_sigset_t *, sigqueue_t *,
813 	k_sigset_t *, sigqueue_t *);
814 extern void winfo(proc_t *, k_siginfo_t *, int);
815 extern int wstat(int, int);
816 extern int sendsig(int, k_siginfo_t *, void (*)());
817 #if defined(_SYSCALL32_IMPL)
818 extern int sendsig32(int, k_siginfo_t *, void (*)());
819 #endif
820 
821 #endif	/* _KERNEL */
822 
823 #ifdef	__cplusplus
824 }
825 #endif
826 
827 #endif	/* _SYS_PROC_H */
828