1/*
2 * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
29/*-
30 * Copyright (c) 1986, 1989, 1991, 1993
31 *	The Regents of the University of California.  All rights reserved.
32 * (c) UNIX System Laboratories, Inc.
33 * All or some portions of this file are derived from material licensed
34 * to the University of California by American Telephone and Telegraph
35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
36 * the permission of UNIX System Laboratories, Inc.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 *    notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 *    notice, this list of conditions and the following disclaimer in the
45 *    documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 *    must display the following acknowledgement:
48 *	This product includes software developed by the University of
49 *	California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 *    may be used to endorse or promote products derived from this software
52 *    without specific prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 *
66 *	@(#)proc_internal.h	8.15 (Berkeley) 5/19/95
67 */
68/*
69 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
70 * support for mandatory and extensible security protections.  This notice
71 * is included in support of clause 2.2 (b) of the Apple Public License,
72 * Version 2.0.
73 */
74
75#ifndef _SYS_PROC_INTERNAL_H_
76#define	_SYS_PROC_INTERNAL_H_
77
78#include <libkern/OSAtomic.h>
79#include <sys/proc.h>
80__BEGIN_DECLS
81#include <kern/locks.h>
82#if PSYNCH
83#include <kern/thread_call.h>
84#endif /* PSYNCH */
85__END_DECLS
86
87#if DEBUG
88#define	__PROC_INTERNAL_DEBUG 1
89#endif
90
91/*
92 * The short form for various locks that protect fields in the data structures.
93 * PL = Process Lock
94 * PGL = Process Group Lock
95 * PFDL = Process File Desc Lock
96 * PSL = Process Spin Lock
97 * PPL = Parent Process Lock (planed for later usage)
98 * LL = List Lock
99 * SL = Session Lock
100*/
101struct label;
102
103/*
104 * Added by SPARTA, Inc.
105 */
106/*
107 * Login context.
108 */
109struct lctx {
110	LIST_ENTRY(lctx) lc_list;	/* List of all login contexts. */
111	LIST_HEAD(, proc) lc_members;	/* Pointer to lc members. */
112	int		lc_mc;		/* Member Count. */
113	pid_t		lc_id;		/* Login context ID. */
114	lck_mtx_t	lc_mtx;		/* Mutex to protect members */
115
116	struct label	*lc_label;	/* Login context MAC label. */
117};
118
119/*
120 * One structure allocated per session.
121 */
122struct	session {
123	int			s_count;		/* Ref cnt; pgrps in session. (LL) */
124	struct	proc *		s_leader;		/* Session leader.(static) */
125	struct	vnode *		s_ttyvp;		/* Vnode of controlling terminal.(SL) */
126	int			s_ttyvid;		/* Vnode id of the controlling terminal (SL) */
127	struct	tty *		s_ttyp;			/* Controlling terminal. (SL + ttyvp != NULL) */
128	pid_t			s_ttypgrpid;		/* tty's pgrp id */
129	pid_t			s_sid;			/* Session ID (static) */
130	char			s_login[MAXLOGNAME];	/* Setlogin() name.(SL) */
131	int			s_flags;		/* Session flags (s_mlock)  */
132	LIST_ENTRY(session)	s_hash;			/* Hash chain.(LL) */
133	lck_mtx_t		s_mlock;		/* mutex lock to protect session */
134	int			s_listflags;
135};
136
137#define SESSION_NULL (struct session *)0
138
139/*
140 * accessor for s_ttyp which treats it as invalid if s_ttyvp is not valid;
141 * note that s_ttyp is not a reference in the session structre, so it can
142 * become invalid out from under the session if the device is closed, without
143 * this protection.  We can't safely make it into a reference without reflexive
144 * close notification of tty devices through cdevsw[].
145 *
146 * NB:	<sys/tty.h> is not in scope and there is not typedef type enforcement,
147 *	or '0' below would be 'TTY_NULL'.
148 */
149#define SESSION_TP(sp)	(((sp)->s_ttyvp != 0) ? (sp)->s_ttyp : 0)
150
151/*
152 * Session flags; used to tunnel information to lower layers and line
153 * disciplines, etc.
154 */
155#define	S_DEFAULT	0x00000000	/* No flags set */
156#define	S_NOCTTY	0x00000001	/* Do not associate controlling tty */
157
158
159#define S_LIST_TERM	1		/* marked for termination */
160#define	S_LIST_DEAD	2		/* already dead */
161/*
162 * One structure allocated per process group.
163 */
164struct	pgrp {
165	LIST_ENTRY(pgrp)	pg_hash;	/* Hash chain. (LL) */
166	LIST_HEAD(, proc) 	pg_members;	/* Pointer to pgrp members. (PGL) */
167	struct	session *	pg_session;	/* Pointer to session. (LL ) */
168	pid_t			pg_id;		/* Pgrp id. (static) */
169	int			pg_jobc;	/* # procs qualifying pgrp for job control (PGL) */
170	int			pg_membercnt;	/* Number of processes in the pgrocess group (PGL) */
171	int			pg_refcount;	/* number of current iterators (LL) */
172	unsigned int		pg_listflags;	/* (LL) */
173	lck_mtx_t		pg_mlock;	/* mutex lock to protect pgrp */
174};
175
176#define PGRP_FLAG_TERMINATE 	1
177#define PGRP_FLAG_WAITTERMINATE 2
178#define PGRP_FLAG_DEAD 		4
179#define PGRP_FLAG_ITERABEGIN 	8
180#define PGRP_FLAG_ITERWAIT 	0x10
181
182#define PGRP_NULL (struct pgrp *)0
183struct proc;
184
185#define PROC_NULL (struct proc *)0
186
187#define PROC_UPDATE_CREDS_ONPROC(p) { \
188	p->p_uid =  kauth_cred_getuid(p->p_ucred); \
189	p->p_gid =  kauth_cred_getgid(p->p_ucred); \
190	p->p_ruid =  kauth_cred_getruid(p->p_ucred); \
191	p->p_rgid =  kauth_cred_getrgid(p->p_ucred); \
192	p->p_svuid =  kauth_cred_getsvuid(p->p_ucred); \
193	p->p_svgid =  kauth_cred_getsvgid(p->p_ucred); \
194	}
195/*
196 * Description of a process.
197 *
198 * This structure contains the information needed to manage a thread of
199 * control, known in UN*X as a process; it has references to substructures
200 * containing descriptions of things that the process uses, but may share
201 * with related processes.  The process structure and the substructures
202 * are always addressible except for those marked "(PROC ONLY)" below,
203 * which might be addressible only on a processor on which the process
204 * is running.
205 */
206struct	proc {
207	LIST_ENTRY(proc) p_list;		/* List of all processes. */
208
209	pid_t		p_pid;			/* Process identifier. (static)*/
210	void * 		task;			/* corresponding task (static)*/
211	struct	proc *	p_pptr;		 	/* Pointer to parent process.(LL) */
212	pid_t		p_ppid;			/* process's parent pid number */
213	pid_t		p_pgrpid;		/* process group id of the process (LL)*/
214	uid_t		p_uid;
215	gid_t		p_gid;
216	uid_t		p_ruid;
217	gid_t		p_rgid;
218	uid_t		p_svuid;
219	gid_t		p_svgid;
220	uint64_t	p_uniqueid;		/* process uniqe ID */
221
222	lck_mtx_t 	p_mlock;		/* mutex lock for proc */
223
224	char		p_stat;			/* S* process status. (PL)*/
225	char		p_shutdownstate;
226	char		p_kdebug;		/* P_KDEBUG eq (CC)*/
227	char		p_btrace;		/* P_BTRACE eq (CC)*/
228
229	LIST_ENTRY(proc) p_pglist;		/* List of processes in pgrp.(PGL) */
230	LIST_ENTRY(proc) p_sibling;		/* List of sibling processes. (LL)*/
231	LIST_HEAD(, proc) p_children;		/* Pointer to list of children. (LL)*/
232	TAILQ_HEAD( , uthread) p_uthlist; 	/* List of uthreads  (PL) */
233
234	LIST_ENTRY(proc) p_hash;		/* Hash chain. (LL)*/
235	TAILQ_HEAD( ,eventqelt) p_evlist;	/* (PL) */
236
237	lck_mtx_t	p_fdmlock;		/* proc lock to protect fdesc */
238
239	/* substructures: */
240	kauth_cred_t	p_ucred;		/* Process owner's identity. (PL) */
241	struct	filedesc *p_fd;			/* Ptr to open files structure. (PFDL) */
242	struct	pstats *p_stats;		/* Accounting/statistics (PL). */
243	struct	plimit *p_limit;		/* Process limits.(PL) */
244
245	struct	sigacts *p_sigacts;		/* Signal actions, state (PL) */
246	 int		p_siglist;		/* signals captured back from threads */
247	lck_spin_t	p_slock;		/* spin lock for itimer/profil protection */
248
249#define	p_rlimit	p_limit->pl_rlimit
250
251	struct	plimit *p_olimit;		/* old process limits  - not inherited by child  (PL) */
252	unsigned int	p_flag;			/* P_* flags. (atomic bit ops) */
253	unsigned int	p_lflag;		/* local flags  (PL) */
254	unsigned int	p_listflag;		/* list flags (LL) */
255	unsigned int	p_ladvflag;		/* local adv flags (atomic) */
256	int		p_refcount;		/* number of outstanding users(LL) */
257	int		p_childrencnt;		/* children holding ref on parent (LL) */
258	int		p_parentref;		/* children lookup ref on parent (LL) */
259
260	pid_t		p_oppid;	 	/* Save parent pid during ptrace. XXX */
261	u_int		p_xstat;		/* Exit status for wait; also stop signal. */
262
263#ifdef _PROC_HAS_SCHEDINFO_
264	/* may need cleanup, not used */
265	u_int		p_estcpu;	 	/* Time averaged value of p_cpticks.(used by aio and proc_comapre) */
266	fixpt_t		p_pctcpu;	 	/* %cpu for this process during p_swtime (used by aio)*/
267	u_int		p_slptime;		/* used by proc_compare */
268#endif /* _PROC_HAS_SCHEDINFO_ */
269
270	struct	itimerval p_realtimer;		/* Alarm timer. (PSL) */
271	struct	timeval p_rtime;		/* Real time.(PSL)  */
272	struct	itimerval p_vtimer_user;	/* Virtual timers.(PSL)  */
273	struct	itimerval p_vtimer_prof;	/* (PSL) */
274
275	struct	timeval	p_rlim_cpu;		/* Remaining rlim cpu value.(PSL) */
276	int		p_debugger;		/*  NU 1: can exec set-bit programs if suser */
277	boolean_t	sigwait;	/* indication to suspend (PL) */
278	void	*sigwait_thread;	/* 'thread' holding sigwait(PL)  */
279	void	*exit_thread;		/* Which thread is exiting(PL)  */
280	int	p_vforkcnt;		/* number of outstanding vforks(PL)  */
281    	void *  p_vforkact;     	/* activation running this vfork proc)(static)  */
282	int	p_fpdrainwait;		/* (PFDL) */
283	pid_t	p_contproc;	/* last PID to send us a SIGCONT (PL) */
284
285	/* Following fields are info from SIGCHLD (PL) */
286	pid_t	si_pid;			/* (PL) */
287	u_int   si_status;		/* (PL) */
288	u_int	si_code;		/* (PL) */
289	uid_t	si_uid;			/* (PL) */
290
291	void * vm_shm;			/* (SYSV SHM Lock) for sysV shared memory */
292
293#if CONFIG_DTRACE
294	user_addr_t			p_dtrace_argv;			/* (write once, read only after that) */
295	user_addr_t			p_dtrace_envp;			/* (write once, read only after that) */
296	lck_mtx_t			p_dtrace_sprlock;		/* sun proc lock emulation */
297	int				p_dtrace_probes;		/* (PL) are there probes for this proc? */
298	u_int				p_dtrace_count;			/* (sprlock) number of DTrace tracepoints */
299        uint8_t                         p_dtrace_stop;                  /* indicates a DTrace-desired stop */
300	struct dtrace_ptss_page*	p_dtrace_ptss_pages;		/* (sprlock) list of user ptss pages */
301	struct dtrace_ptss_page_entry*	p_dtrace_ptss_free_list;	/* (atomic) list of individual ptss entries */
302	struct dtrace_helpers*		p_dtrace_helpers;		/* (dtrace_lock) DTrace per-proc private */
303	struct dof_ioctl_data*		p_dtrace_lazy_dofs;		/* (sprlock) unloaded dof_helper_t's */
304#endif /* CONFIG_DTRACE */
305
306/* XXXXXXXXXXXXX BCOPY'ed on fork XXXXXXXXXXXXXXXX */
307/* The following fields are all copied upon creation in fork. */
308#define	p_startcopy	p_argslen
309
310	u_int	p_argslen;	 /* Length of process arguments. */
311	int  	p_argc;			/* saved argc for sysctl_procargs() */
312	user_addr_t user_stack;		/* where user stack was allocated */
313	struct	vnode *p_textvp;	/* Vnode of executable. */
314	off_t	p_textoff;		/* offset in executable vnode */
315
316	sigset_t p_sigmask;		/* DEPRECATED */
317	sigset_t p_sigignore;	/* Signals being ignored. (PL) */
318	sigset_t p_sigcatch;	/* Signals being caught by user.(PL)  */
319
320	u_char	p_priority;	/* (NU) Process priority. */
321	u_char	p_resv0;	/* (NU) User-priority based on p_cpu and p_nice. */
322	char	p_nice;		/* Process "nice" value.(PL) */
323	u_char	p_resv1;	/* (NU) User-priority based on p_cpu and p_nice. */
324
325#if CONFIG_MACF
326	int	p_mac_enforce;			/* MAC policy enforcement control */
327#endif
328
329	char	p_comm[MAXCOMLEN+1];
330	char	p_name[(2*MAXCOMLEN)+1];	/* PL */
331
332	struct 	pgrp *p_pgrp;	/* Pointer to process group. (LL) */
333	uint32_t	p_csflags;	/* flags for codesign (PL) */
334	uint32_t	p_pcaction;	/* action  for process control on starvation */
335	uint8_t p_uuid[16];		/* from LC_UUID load command */
336
337#if !CONFIG_EMBEDDED
338#define PROC_LEGACY_BEHAVIOR_IOTHROTTLE (0x00000001)
339	 uint32_t	p_legacy_behavior;
340#endif
341
342/* End area that is copied on creation. */
343/* XXXXXXXXXXXXX End of BCOPY'ed on fork (AIOLOCK)XXXXXXXXXXXXXXXX */
344#define	p_endcopy	p_aio_total_count
345	int		p_aio_total_count;		/* all allocated AIO requests for this proc */
346	int		p_aio_active_count;		/* all unfinished AIO requests for this proc */
347	TAILQ_HEAD( , aio_workq_entry ) p_aio_activeq; 	/* active async IO requests */
348	TAILQ_HEAD( , aio_workq_entry ) p_aio_doneq;	/* completed async IO requests */
349
350	struct klist p_klist;  /* knote list (PL ?)*/
351
352	struct	rusage *p_ru;	/* Exit information. (PL) */
353	int		p_sigwaitcnt;
354	thread_t 	p_signalholder;
355	thread_t 	p_transholder;
356
357	/* DEPRECATE following field  */
358	u_short	p_acflag;	/* Accounting flags. */
359
360	struct lctx *p_lctx;		/* Pointer to login context. */
361	LIST_ENTRY(proc) p_lclist;	/* List of processes in lctx. */
362	user_addr_t 	p_threadstart;		/* pthread start fn */
363	user_addr_t 	p_wqthread;		/* pthread workqueue fn */
364	int 	p_pthsize;			/* pthread size */
365	user_addr_t	p_targconc;		/* target concurrency ptr */
366	void * 	p_wqptr;			/* workq ptr */
367	int 	p_wqsize;			/* allocated size */
368	boolean_t       p_wqiniting;            /* semaphore to serialze wq_open */
369	lck_spin_t	p_wqlock;		/* lock to protect work queue */
370	struct  timeval p_start;        	/* starting time */
371	void *	p_rcall;
372	int		p_ractive;
373	int	p_idversion;		/* version of process identity */
374	void *	p_pthhash;			/* pthread waitqueue hash */
375#if DIAGNOSTIC
376	unsigned int p_fdlock_pc[4];
377	unsigned int p_fdunlock_pc[4];
378#if SIGNAL_DEBUG
379	unsigned int lockpc[8];
380	unsigned int unlockpc[8];
381#endif /* SIGNAL_DEBUG */
382#endif /* DIAGNOSTIC */
383	uint64_t	p_dispatchqueue_offset;
384#if VM_PRESSURE_EVENTS
385	struct timeval	vm_pressure_last_notify_tstamp;
386#endif
387	int		p_dirty;			/* dirty state */
388};
389
390#define PGRPID_DEAD 0xdeaddead
391
392/* p_listflag */
393#define P_LIST_DRAIN   			0x00000001
394#define P_LIST_DRAINWAIT 		0x00000002
395#define P_LIST_DRAINED   		0x00000004
396#define P_LIST_DEAD				0x00000008
397#define P_LIST_WAITING   		0x00000010
398#define P_LIST_EXITED    		0x00000040
399#define P_LIST_CHILDDRSTART    	0x00000080
400#define P_LIST_CHILDDRAINED    	0x00000100
401#define P_LIST_CHILDDRWAIT    	0x00000200
402#define P_LIST_CHILDLKWAIT    	0x00000400
403#define P_LIST_DEADPARENT    	0x00000800
404#define P_LIST_PARENTREFWAIT   	0x00001000
405#define P_LIST_INCREATE   		0x00002000
406/* 0x4000 &  0x8000 Not used */
407#define P_LIST_INHASH	 		0x00010000	/* process is in hash */
408#define P_LIST_INPGRP	 		0x00020000	/* process is in pgrp */
409#define P_LIST_PGRPTRANS 		0x00040000	/* pgrp is getting replaced */
410#define P_LIST_PGRPTRWAIT 		0x00080000	/* wait for pgrp replacement */
411#define P_LIST_EXITCOUNT 		0x00100000	/* counted for process exit */
412
413
414/* local flags */
415#define	P_LDELAYTERM	0x00000001	/* */
416#define	P_LNOZOMB	0x00000002 	/* */
417#define P_LTERM		0x00000004      /* */
418#define P_LEXIT		0x00000008      /* */
419#define P_LPEXIT	0x00000010
420#define	P_LTRANSCOMMIT	0x00000020	/* process is committed to trans */
421#define	P_LINTRANSIT	0x00000040	/* process in exec or in creation */
422#define	P_LTRANSWAIT	0x00000080	/* waiting for trans to complete */
423#define P_LVFORK        0x00000100      /* */
424#define P_LINVFORK      0x00000200      /* */
425#define P_LTRACED       0x00000400      /* */
426#define P_LSIGEXC       0x00000800      /* */
427#define P_LNOATTACH     0x00001000      /* */
428#define P_LPPWAIT       0x00002000      /* */
429#define	P_LKQWDRAIN	0x00004000
430#define	P_LKQWDRAINWAIT	0x00008000
431#define	P_LKQWDEAD	0x00010000
432#define	P_LLIMCHANGE	0x00020000
433#define	P_LLIMWAIT	0x00040000
434#define P_LWAITED   	0x00080000
435#define P_LINSIGNAL    	0x00100000
436#define P_UNUSED  	0x00200000 	/* Unused */
437#define P_LRAGE_VNODES	0x00400000
438#define P_LREGISTER	0x00800000	/* thread start fns registered  */
439#define P_LVMRSRCOWNER	0x01000000	/* can handle the resource ownership of  */
440#define P_LPTERMINATE	0x02000000	/* can handle the resource ownership of  */
441
442/* Process control state for resource starvation */
443#define P_PCTHROTTLE	1
444#define P_PCSUSP	2
445#define P_PCKILL	3
446#define P_PCMAX		3
447
448/* Process control action state on resrouce starvation */
449#define PROC_ACTION_MASK 0xffff0000;
450#define PROC_CONTROL_STATE(p) (p->p_pcaction & P_PCMAX)
451#define PROC_ACTION_STATE(p) ((p->p_pcaction >> 16) & P_PCMAX)
452#define PROC_SETACTION_STATE(p) (p->p_pcaction = (PROC_CONTROL_STATE(p) | (PROC_CONTROL_STATE(p) << 16)))
453#define PROC_RESETACTION_STATE(p) (p->p_pcaction = PROC_CONTROL_STATE(p))
454
455/* additional process flags */
456#define P_LADVLOCK		0x01
457
458/* defns for proc_iterate */
459#define PROC_ALLPROCLIST        1		/* walk the allproc list (procs not exited yet) */
460#define PROC_ZOMBPROCLIST       2		/*  walk the zombie list */
461#define PROC_NOWAITTRANS       4		/* do not wait for transitions (checkdirs only)  */
462
463/* defns for pgrp_iterate */
464#define PGRP_DROPREF    	1
465#define	PGRP_BLOCKITERATE 	2
466
467/* return values of the proc iteration callback routine */
468#define PROC_RETURNED           0
469#define PROC_RETURNED_DONE      1
470#define PROC_CLAIMED            2
471#define PROC_CLAIMED_DONE       3
472
473/* process creation arguments */
474#define	PROC_CREATE_FORK	0	/* independent child (running) */
475#define	PROC_CREATE_SPAWN	1	/* independent child (suspended) */
476#define	PROC_CREATE_VFORK	2	/* child borrows context */
477
478
479/* LP64 version of extern_proc.  all pointers
480 * grow when we're dealing with a 64-bit process.
481 * WARNING - keep in sync with extern_proc
482 * but use native alignment of 64-bit process.
483 */
484
485#ifdef KERNEL
486#include <sys/time.h>	/* user_timeval, user_itimerval */
487
488#pragma pack(4)
489struct user32_extern_proc {
490	union {
491		struct {
492			uint32_t __p_forw;	/* Doubly-linked run/sleep queue. */
493			uint32_t __p_back;
494		} p_st1;
495		struct user32_timeval __p_starttime; 	/* process start time */
496	} p_un;
497	uint32_t 	p_vmspace;	/* Address space. */
498	uint32_t	p_sigacts;	/* Signal actions, state (PROC ONLY). */
499	int		p_flag;			/* P_* flags. */
500	char	p_stat;			/* S* process status. */
501	pid_t	p_pid;			/* Process identifier. */
502	pid_t	p_oppid;		/* Save parent pid during ptrace. XXX */
503	int		p_dupfd;		/* Sideways return value from fdopen. XXX */
504	/* Mach related  */
505	uint32_t user_stack;	/* where user stack was allocated */
506	uint32_t exit_thread;  /* XXX Which thread is exiting? */
507	int		p_debugger;		/* allow to debug */
508	boolean_t	sigwait;	/* indication to suspend */
509	/* scheduling */
510	u_int	p_estcpu;	 /* Time averaged value of p_cpticks. */
511	int		p_cpticks;	 /* Ticks of cpu time. */
512	fixpt_t	p_pctcpu;	 /* %cpu for this process during p_swtime */
513	uint32_t	p_wchan;	 /* Sleep address. */
514	uint32_t	p_wmesg;	 /* Reason for sleep. */
515	u_int	p_swtime;	 /* Time swapped in or out. */
516	u_int	p_slptime;	 /* Time since last blocked. */
517	struct	user32_itimerval p_realtimer;	/* Alarm timer. */
518	struct	user32_timeval p_rtime;	/* Real time. */
519	u_quad_t p_uticks;		/* Statclock hits in user mode. */
520	u_quad_t p_sticks;		/* Statclock hits in system mode. */
521	u_quad_t p_iticks;		/* Statclock hits processing intr. */
522	int		p_traceflag;		/* Kernel trace points. */
523	uint32_t	p_tracep;	/* Trace to vnode. */
524	int		p_siglist;		/* DEPRECATED */
525	uint32_t	p_textvp;	/* Vnode of executable. */
526	int		p_holdcnt;		/* If non-zero, don't swap. */
527	sigset_t p_sigmask;	/* DEPRECATED. */
528	sigset_t p_sigignore;	/* Signals being ignored. */
529	sigset_t p_sigcatch;	/* Signals being caught by user. */
530	u_char	p_priority;	/* Process priority. */
531	u_char	p_usrpri;	/* User-priority based on p_cpu and p_nice. */
532	char	p_nice;		/* Process "nice" value. */
533	char	p_comm[MAXCOMLEN+1];
534	uint32_t	p_pgrp;	/* Pointer to process group. */
535	uint32_t	p_addr;	/* Kernel virtual addr of u-area (PROC ONLY). */
536	u_short	p_xstat;	/* Exit status for wait; also stop signal. */
537	u_short	p_acflag;	/* Accounting flags. */
538	uint32_t	p_ru;	/* Exit information. XXX */
539};
540#pragma pack()
541struct user64_extern_proc {
542	union {
543		struct {
544			user_addr_t __p_forw;	/* Doubly-linked run/sleep queue. */
545			user_addr_t __p_back;
546		} p_st1;
547		struct user64_timeval __p_starttime; 	/* process start time */
548	} p_un;
549	user_addr_t 	p_vmspace;	/* Address space. */
550	user_addr_t		p_sigacts;	/* Signal actions, state (PROC ONLY). */
551	int		p_flag;			/* P_* flags. */
552	char	p_stat;			/* S* process status. */
553	pid_t	p_pid;			/* Process identifier. */
554	pid_t	p_oppid;		/* Save parent pid during ptrace. XXX */
555	int		p_dupfd;		/* Sideways return value from fdopen. XXX */
556	/* Mach related  */
557	user_addr_t user_stack __attribute((aligned(8)));	/* where user stack was allocated */
558	user_addr_t exit_thread;  /* XXX Which thread is exiting? */
559	int		p_debugger;		/* allow to debug */
560	boolean_t	sigwait;	/* indication to suspend */
561	/* scheduling */
562	u_int	p_estcpu;	 /* Time averaged value of p_cpticks. */
563	int		p_cpticks;	 /* Ticks of cpu time. */
564	fixpt_t	p_pctcpu;	 /* %cpu for this process during p_swtime */
565	user_addr_t	p_wchan __attribute((aligned(8)));	 /* Sleep address. */
566	user_addr_t	p_wmesg;	 /* Reason for sleep. */
567	u_int	p_swtime;	 /* Time swapped in or out. */
568	u_int	p_slptime;	 /* Time since last blocked. */
569	struct	user64_itimerval p_realtimer;	/* Alarm timer. */
570	struct	user64_timeval p_rtime;	/* Real time. */
571	u_quad_t p_uticks;		/* Statclock hits in user mode. */
572	u_quad_t p_sticks;		/* Statclock hits in system mode. */
573	u_quad_t p_iticks;		/* Statclock hits processing intr. */
574	int		p_traceflag;		/* Kernel trace points. */
575	user_addr_t	p_tracep __attribute((aligned(8)));	/* Trace to vnode. */
576	int		p_siglist;		/* DEPRECATED */
577	user_addr_t	p_textvp __attribute((aligned(8)));	/* Vnode of executable. */
578	int		p_holdcnt;		/* If non-zero, don't swap. */
579	sigset_t p_sigmask;	/* DEPRECATED. */
580	sigset_t p_sigignore;	/* Signals being ignored. */
581	sigset_t p_sigcatch;	/* Signals being caught by user. */
582	u_char	p_priority;	/* Process priority. */
583	u_char	p_usrpri;	/* User-priority based on p_cpu and p_nice. */
584	char	p_nice;		/* Process "nice" value. */
585	char	p_comm[MAXCOMLEN+1];
586	user_addr_t	p_pgrp __attribute((aligned(8)));	/* Pointer to process group. */
587	user_addr_t	p_addr;	/* Kernel virtual addr of u-area (PROC ONLY). */
588	u_short	p_xstat;	/* Exit status for wait; also stop signal. */
589	u_short	p_acflag;	/* Accounting flags. */
590	user_addr_t	p_ru __attribute((aligned(8)));	/* Exit information. XXX */
591};
592#endif	/* KERNEL */
593
594/*
595 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
596 * as it is used to represent "no process group".
597 */
598extern int nprocs, maxproc;		/* Current and max number of procs. */
599extern int maxprocperuid;		/* Current number of procs per uid */
600__private_extern__ int hard_maxproc;	/* hard limit */
601extern unsigned int proc_shutdown_exitcount;
602
603#define	PID_MAX		99999
604#define	NO_PID		100000
605extern lck_mtx_t * proc_list_mlock;
606extern lck_mtx_t * proc_klist_mlock;
607
608#define BSD_SIMUL_EXECS		33 /* 32 , allow for rounding */
609#define	BSD_PAGEABLE_SIZE_PER_EXEC	(NCARGS + PAGE_SIZE + PAGE_SIZE) /* page for apple vars, page for executable header */
610extern int execargs_cache_size;
611extern int execargs_free_count;
612extern vm_offset_t * execargs_cache;
613
614#define SESS_LEADER(p, sessp)	((sessp)->s_leader == (p))
615
616/* Lock and unlock a login context. */
617#define LCTX_LOCK(lc)	lck_mtx_lock(&(lc)->lc_mtx)
618#define LCTX_UNLOCK(lc)	lck_mtx_unlock(&(lc)->lc_mtx)
619#define LCTX_LOCKED(lc)
620#define LCTX_LOCK_ASSERT(lc, type)
621#define ALLLCTX_LOCK	lck_mtx_lock(&alllctx_lock)
622#define ALLLCTX_UNLOCK	lck_mtx_unlock(&alllctx_lock)
623extern lck_mtx_t alllctx_lock;
624extern lck_grp_t * lctx_lck_grp;
625extern lck_grp_attr_t * lctx_lck_grp_attr;
626extern lck_attr_t * lctx_lck_attr;
627
628#define	PIDHASH(pid)	(&pidhashtbl[(pid) & pidhash])
629extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
630extern u_long pidhash;
631
632#define	PGRPHASH(pgid)	(&pgrphashtbl[(pgid) & pgrphash])
633extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
634extern u_long pgrphash;
635#define	SESSHASH(sessid) (&sesshashtbl[(sessid) & sesshash])
636extern LIST_HEAD(sesshashhead, session) *sesshashtbl;
637extern u_long sesshash;
638
639extern lck_grp_t * proc_lck_grp;
640#if CONFIG_FINE_LOCK_GROUPS
641extern lck_grp_t * proc_mlock_grp;
642extern lck_grp_t * proc_fdmlock_grp;
643extern lck_grp_t * proc_slock_grp;
644#endif
645extern lck_grp_attr_t * proc_lck_grp_attr;
646extern lck_attr_t * proc_lck_attr;
647
648LIST_HEAD(proclist, proc);
649extern struct proclist allproc;		/* List of all processes. */
650extern struct proclist zombproc;	/* List of zombie processes. */
651extern struct proc *initproc;
652extern void	procinit(void) __attribute__((section("__TEXT, initcode")));
653extern void proc_lock(struct proc *);
654extern void proc_unlock(struct proc *);
655extern void proc_spinlock(struct proc *);
656extern void proc_spinunlock(struct proc *);
657extern void proc_list_lock(void);
658extern void proc_list_unlock(void);
659extern void proc_klist_lock(void);
660extern void proc_klist_unlock(void);
661extern void proc_fdlock(struct proc *);
662extern void proc_fdlock_spin(struct proc *);
663extern void proc_fdunlock(struct proc *);
664extern void proc_fdlock_assert(proc_t p, int assertflags);
665__private_extern__ int proc_core_name(const char *name, uid_t uid, pid_t pid,
666		char *cr_name, size_t cr_name_len);
667extern int isinferior(struct proc *, struct proc *);
668__private_extern__ struct proc *pzfind(pid_t);	/* Find zombie by id. */
669__private_extern__ struct proc *proc_find_zombref(pid_t);	/* Find zombie by id. */
670__private_extern__ void proc_drop_zombref(struct proc * p);	/* Find zombie by id. */
671
672
673extern struct	lctx *lcfind(pid_t);		/* Find a login context by id */
674extern struct	lctx *lccreate(void);		/* Create a new login context */
675
676extern int	chgproccnt(uid_t uid, int diff);
677extern void	enterlctx(struct proc *p, struct lctx *l, int create);
678extern void	pinsertchild(struct proc *parent, struct proc *child);
679extern int	enterpgrp(struct proc *p, pid_t pgid, int mksess);
680extern void	fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
681extern int	inferior(struct proc *p);
682extern int	leavepgrp(struct proc *p);
683extern void	leavelctx(struct proc *p);
684extern void	resetpriority(struct proc *);
685extern void	setrunnable(struct proc *);
686extern void	setrunqueue(struct proc *);
687extern int	sleep(void *chan, int pri);
688extern int	tsleep0(void *chan, int pri, const char *wmesg, int timo, int (*continuation)(int));
689extern int	tsleep1(void *chan, int pri, const char *wmesg, u_int64_t abstime, int (*continuation)(int));
690extern int	msleep0(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, int timo, int (*continuation)(int));
691extern void	vfork_return(struct proc *child, int32_t *retval, int rval);
692extern int	exit1(struct proc *, int, int *);
693extern int	exit1_internal(struct proc *, int, int *, boolean_t, boolean_t);
694extern int	fork1(proc_t, thread_t *, int);
695extern void vfork_exit_internal(struct proc *p, int rv, int forced);
696extern void proc_reparentlocked(struct proc *child, struct proc * newparent, int cansignal, int locked);
697extern int pgrp_iterate(struct pgrp * pgrp, int flags, int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg);
698extern int proc_iterate(int flags, int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg);
699extern int proc_rebootscan(int (*callout)(proc_t , void *), void *arg, int (*filterfn)(proc_t , void *), void *filterarg);
700extern int proc_childrenwalk(proc_t p, int (*callout)(proc_t , void *), void *arg);
701extern proc_t proc_findinternal(int pid, int funneled);
702extern proc_t proc_findthread(thread_t thread);
703extern void proc_refdrain(proc_t);
704extern void proc_childdrainlocked(proc_t);
705extern void proc_childdrainstart(proc_t);
706extern void proc_childdrainend(proc_t);
707extern void  proc_checkdeadrefs(proc_t);
708struct proc *pfind_locked(pid_t);
709extern struct pgrp *pgfind(pid_t);
710extern void pg_rele(struct pgrp * pgrp);
711extern struct session * session_find_internal(pid_t sessid);
712extern struct pgrp * proc_pgrp(proc_t);
713extern struct pgrp * tty_pgrp(struct tty * tp);
714extern struct pgrp * pgfind_internal(pid_t);
715extern struct session * proc_session(proc_t);
716extern void pgrp_lock(struct pgrp * pgrp);
717extern void pgrp_unlock(struct pgrp * pgrp);
718extern void session_lock(struct session * sess);
719extern void session_unlock(struct session * sess);
720extern struct session * pgrp_session(struct pgrp * pgrp);
721extern void	session_rele(struct session *sess);
722extern int isbackground(proc_t p, struct tty  *tp);
723extern proc_t proc_parent(proc_t);
724extern proc_t proc_parentholdref(proc_t);
725extern int proc_parentdropref(proc_t, int);
726int     itimerfix(struct timeval *tv);
727int     itimerdecr(struct proc * p, struct itimerval *itp, int usec);
728void proc_signalstart(struct proc *, int locked);
729void proc_signalend(struct proc *, int locked);
730int  proc_transstart(struct proc *, int locked);
731void proc_transcommit(struct proc *, int locked);
732void proc_transend(struct proc *, int locked);
733int  proc_transwait(struct proc *, int locked);
734void  proc_rele_locked(struct proc *  p);
735struct proc *proc_ref_locked(struct proc *  p);
736void proc_knote(struct proc * p, long hint);
737void proc_knote_drain(struct proc *p);
738void workqueue_init_lock(proc_t p);
739void workqueue_destroy_lock(proc_t p);
740void proc_setregister(proc_t p);
741void proc_resetregister(proc_t p);
742/* returns the first thread_t in the process, or NULL XXX for NFS, DO NOT USE */
743thread_t proc_thread(proc_t);
744extern int proc_pendingsignals(proc_t, sigset_t);
745int proc_getpcontrol(int pid, int * pcontrolp);
746int proc_dopcontrol(proc_t p, void *unused_arg);
747int proc_resetpcontrol(int pid);
748extern void proc_removethrottle(proc_t);
749#if PSYNCH
750void pth_proc_hashinit(proc_t);
751void pth_proc_hashdelete(proc_t);
752void pth_global_hashinit(void);
753extern thread_call_t psynch_thcall;
754void psynch_wq_cleanup(__unused void *  param, __unused void * param1);
755extern lck_mtx_t * pthread_list_mlock;
756#endif /* PSYNCH */
757struct uthread * current_uthread(void);
758#endif	/* !_SYS_PROC_INTERNAL_H_ */
759