[apple/xnu.git] / bsd / sys / proc.h

/*
 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*-
 * Copyright (c) 1986, 1989, 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)proc.h	8.15 (Berkeley) 5/19/95
 */

#ifndef _SYS_PROC_H_
#define	_SYS_PROC_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <sys/select.h>			/* For struct selinfo. */
#include <sys/queue.h>
#include <sys/lock.h>
#include <sys/param.h>
#include <sys/event.h>
#ifdef KERNEL
#include <sys/kernel_types.h>
#endif
#include <mach/boolean.h>

#if defined(XNU_KERNEL_PRIVATE) || !defined(KERNEL) 

struct session;
struct pgrp;
struct proc;

/* Exported fields for kern sysctls */
struct extern_proc {
	union {
		struct {
			struct	proc *__p_forw;	/* Doubly-linked run/sleep queue. */
			struct	proc *__p_back;
		} p_st1;
		struct timeval __p_starttime; 	/* process start time */
	} p_un;
#define p_forw p_un.p_st1.__p_forw
#define p_back p_un.p_st1.__p_back
#define p_starttime p_un.__p_starttime
	struct	vmspace *p_vmspace;	/* Address space. */
	struct	sigacts *p_sigacts;	/* Signal actions, state (PROC ONLY). */
	int	p_flag;			/* P_* flags. */
	char	p_stat;			/* S* process status. */
	pid_t	p_pid;			/* Process identifier. */
	pid_t	p_oppid;	 /* Save parent pid during ptrace. XXX */
	int	p_dupfd;	 /* Sideways return value from fdopen. XXX */
	/* Mach related  */
	caddr_t user_stack;	/* where user stack was allocated */
	void	*exit_thread;	/* XXX Which thread is exiting? */
	int		p_debugger;		/* allow to debug */
	boolean_t	sigwait;	/* indication to suspend */
	/* scheduling */
	u_int	p_estcpu;	 /* Time averaged value of p_cpticks. */
	int	p_cpticks;	 /* Ticks of cpu time. */
	fixpt_t	p_pctcpu;	 /* %cpu for this process during p_swtime */
	void	*p_wchan;	 /* Sleep address. */
	char	*p_wmesg;	 /* Reason for sleep. */
	u_int	p_swtime;	 /* Time swapped in or out. */
	u_int	p_slptime;	 /* Time since last blocked. */
	struct	itimerval p_realtimer;	/* Alarm timer. */
	struct	timeval p_rtime;	/* Real time. */
	u_quad_t p_uticks;		/* Statclock hits in user mode. */
	u_quad_t p_sticks;		/* Statclock hits in system mode. */
	u_quad_t p_iticks;		/* Statclock hits processing intr. */
	int	p_traceflag;		/* Kernel trace points. */
	struct	vnode *p_tracep;	/* Trace to vnode. */
	int	p_siglist;		/* DEPRECATED. */
	struct	vnode *p_textvp;	/* Vnode of executable. */
	int	p_holdcnt;		/* If non-zero, don't swap. */
	sigset_t p_sigmask;	/* DEPRECATED. */
	sigset_t p_sigignore;	/* Signals being ignored. */
	sigset_t p_sigcatch;	/* Signals being caught by user. */
	u_char	p_priority;	/* Process priority. */
	u_char	p_usrpri;	/* User-priority based on p_cpu and p_nice. */
	char	p_nice;		/* Process "nice" value. */
	char	p_comm[MAXCOMLEN+1];
	struct 	pgrp *p_pgrp;	/* Pointer to process group. */
	struct	user *p_addr;	/* Kernel virtual addr of u-area (PROC ONLY). */
	u_short	p_xstat;	/* Exit status for wait; also stop signal. */
	u_short	p_acflag;	/* Accounting flags. */
	struct	rusage *p_ru;	/* Exit information. XXX */
};


/* Status values. */
#define	SIDL	1		/* Process being created by fork. */
#define	SRUN	2		/* Currently runnable. */
#define	SSLEEP	3		/* Sleeping on an address. */
#define	SSTOP	4		/* Process debugging or suspension. */
#define	SZOMB	5		/* Awaiting collection by parent. */

/* These flags are kept in extern_proc.p_flag. */
#define	P_ADVLOCK	0x00000001	/* Process may hold POSIX adv. lock */
#define	P_CONTROLT	0x00000002	/* Has a controlling terminal */
#define	P_LP64		0x00000004	/* Process is LP64 */
#define	P_NOCLDSTOP	0x00000008	/* No SIGCHLD when children stop */

#define	P_PPWAIT	0x00000010	/* Parent waiting for chld exec/exit */
#define	P_PROFIL	0x00000020	/* Has started profiling */
#define	P_SELECT	0x00000040	/* Selecting; wakeup/waiting danger */
#define	P_CONTINUED	0x00000080	/* Process was stopped and continued */

#define	P_SUGID		0x00000100	/* Has set privileges since last exec */
#define	P_SYSTEM	0x00000200	/* Sys proc: no sigs, stats or swap */
#define	P_TIMEOUT	0x00000400	/* Timing out during sleep */
#define	P_TRACED	0x00000800	/* Debugged process being traced */

#define	P_DISABLE_ASLR	0x00001000	/* Disable address space layout randomization */
#define	P_WEXIT		0x00002000	/* Working on exiting */
#define	P_EXEC		0x00004000	/* Process called exec. */

/* Should be moved to machine-dependent areas. */
#define	P_OWEUPC	0x00008000	/* Owe process an addupc() call at next ast. */

#define	P_AFFINITY	0x00010000	/* xxx */
#define	P_TRANSLATED	0x00020000	/* xxx */
#define	P_CLASSIC	P_TRANSLATED	/* xxx */
/*
#define	P_FSTRACE	0x10000	/ * tracing via file system (elsewhere?) * /
#define	P_SSTEP		0x20000	/ * process needs single-step fixup ??? * /
*/

#define	P_DELAYIDLESLEEP 0x00040000	/* Process is marked to delay idle sleep on disk IO */
#define	P_CHECKOPENEVT 	0x00080000	/* check if a vnode has the OPENEVT flag set on open */

#define	P_DEPENDENCY_CAPABLE	0x00100000	/* process is ok to call vfs_markdependency() */
#define	P_REBOOT	0x00200000	/* Process called reboot() */
#define	P_TBE		0x00400000	/* Process is TBE */
#define	P_RESV7		0x00800000	/* (P_SIGEXC)signal exceptions */

#define	P_THCWD		0x01000000	/* process has thread cwd  */
#define	P_RESV9		0x02000000	/* (P_VFORK)process has vfork children */
#define	P_RESV10 	0x04000000	/* used to be P_NOATTACH */
#define	P_RESV11	0x08000000	/* (P_INVFORK) proc in vfork */

#define	P_NOSHLIB	0x10000000	/* no shared libs are in use for proc */
					/* flag set on exec */
#define	P_FORCEQUOTA	0x20000000	/* Force quota for root */
#define	P_NOCLDWAIT	0x40000000	/* No zombies when chil procs exit */
#define	P_NOREMOTEHANG	0x80000000	/* Don't hang on remote FS ops */

#define	P_INMEM		0		/* Obsolete: retained for compilation */
#define	P_NOSWAP	0		/* Obsolete: retained for compilation */
#define	P_PHYSIO	0		/* Obsolete: retained for compilation */
#define	P_FSTRACE	0		/* Obsolete: retained for compilation */
#define	P_SSTEP		0		/* Obsolete: retained for compilation */

#define P_DIRTY_TRACK                           0x00000001      /* track dirty state */
#define P_DIRTY_ALLOW_IDLE_EXIT                 0x00000002      /* process can be idle-exited when clean */
#define P_DIRTY_DEFER                           0x00000004      /* defer initial opt-in to idle-exit */
#define P_DIRTY                                 0x00000008      /* process is dirty */
#define P_DIRTY_SHUTDOWN                        0x00000010      /* process is dirty during shutdown */
#define P_DIRTY_TERMINATED                      0x00000020      /* process has been marked for termination */
#define P_DIRTY_BUSY                            0x00000040      /* serialization flag */
#define P_DIRTY_MARKED                          0x00000080      /* marked dirty previously */
#define P_DIRTY_DEFER_IN_PROGRESS               0x00000100      /* deferral to idle-band in process */

#define P_DIRTY_IS_DIRTY                        (P_DIRTY | P_DIRTY_SHUTDOWN)
#define P_DIRTY_IDLE_EXIT_ENABLED               (P_DIRTY_TRACK|P_DIRTY_ALLOW_IDLE_EXIT)

#endif /* XNU_KERNEL_PRIVATE || !KERNEL */

#ifdef KERNEL
__BEGIN_DECLS

extern proc_t kernproc;

extern int proc_is_classic(proc_t p);
proc_t current_proc_EXTERNAL(void);

extern int	msleep(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, struct timespec * ts );
extern void	wakeup(void *chan);
extern void wakeup_one(caddr_t chan);

/* proc kpis */
/* this routine returns the pid of the current process */
extern int proc_selfpid(void);
/* this routine returns the pid of the parent of the current process */
extern int proc_selfppid(void);
/* this routine returns sends a signal signum to the process identified by the pid */
extern void proc_signal(int pid, int signum);
/* this routine checks whether any signal identified by the mask are pending in the  process identified by the pid. The check is  on all threads of the process. */
extern int proc_issignal(int pid, sigset_t mask);
/* this routine returns 1 if the pid1 is inferior of pid2 */
extern int proc_isinferior(int pid1, int pid2);
/* this routine copies the process's name of the executable to the passed in buffer. It 
 * is always null terminated. The size of the buffer is to be passed in as well. This 
 * routine is to be used typically for debugging 
 */
void proc_name(int pid, char * buf, int size);
/* This routine is simillar to proc_name except it returns for current process */
void proc_selfname(char * buf, int size);

/* find a process with a given pid. This comes with a reference which needs to be dropped by proc_rele */
extern proc_t proc_find(int pid);
/* returns a handle to current process which is referenced. The reference needs to be dropped with proc_rele */
extern proc_t proc_self(void);
/* releases the held reference on the process */
extern int proc_rele(proc_t p);
/* returns the pid of the given process */
extern int proc_pid(proc_t);
/* returns the pid of the parent of a given process */
extern int proc_ppid(proc_t);
/* returns 1 if the process is marked for no remote hangs */
extern int proc_noremotehang(proc_t);
/* returns 1 if the process is marked for force quota */
extern int proc_forcequota(proc_t);

/* this routine returns 1 if the process is running with 64bit address space, else 0 */
extern int proc_is64bit(proc_t);
/* is this process exiting? */
extern int proc_exiting(proc_t);
/* this routine returns error if the process is not one with super user privileges */
int proc_suser(proc_t p);
/* returns the cred assicaited with the process; temporary api */
kauth_cred_t proc_ucred(proc_t p);

extern int proc_tbe(proc_t);

/*!
 @function proc_selfpgrpid
 @abstract Get the process group id for the current process, as with proc_pgrpid().
 @return pgrpid of current process.
 */
pid_t proc_selfpgrpid(void);

/*!
 @function proc_pgrpid
 @abstract Get the process group id for the passed-in process.
 @param p Process whose pgrpid to grab.
 @return pgrpid for "p".
 */
pid_t proc_pgrpid(proc_t);

#ifdef KERNEL_PRIVATE
// mark a process as being allowed to call vfs_markdependency()
void bsd_set_dependency_capable(task_t task);
extern int IS_64BIT_PROCESS(proc_t);

extern int	tsleep(void *chan, int pri, const char *wmesg, int timo);
extern int	msleep1(void *chan, lck_mtx_t *mtx, int pri, const char *wmesg, u_int64_t timo);

task_t proc_task(proc_t);
extern int proc_pidversion(proc_t);
extern int proc_getcdhash(proc_t, unsigned char *);

/*! 
 @function    proc_pidbackgrounded
 @abstract    KPI to determine if a process is currently backgrounded.
 @discussion  The process may move into or out of background state at any time, 
              so be prepared for this value to be outdated immediately. 
 @param pid   PID of the process to be queried.
 @param state Pointer to a value which will be set to 1 if the process
              is currently backgrounded, 0 otherwise. 
 @return      ESRCH if pid cannot be found or has started exiting.

              EINVAL if state is NULL.
 */
extern int proc_pidbackgrounded(pid_t pid, uint32_t* state);

/* 
 * This returns an unique 64bit id of a given process. 
 * Caller needs to hold proper reference on the 
 * passed in process strucutre.
 */
extern uint64_t proc_uniqueid(proc_t);

#endif /* KERNEL_PRIVATE */

#ifdef XNU_KERNEL_PRIVATE

/* unique 64bit id for process's original parent */
extern uint64_t proc_puniqueid(proc_t);

extern void proc_getexecutableuuid(proc_t, unsigned char *, unsigned long);

extern uint64_t proc_was_throttled(proc_t);
extern uint64_t proc_did_throttle(proc_t);

#endif /* XNU_KERNEL_PRIVATE*/

__END_DECLS

#endif	/* KERNEL */

#ifdef PRIVATE

/* Values for pid_shutdown_sockets */
#ifdef KERNEL
#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_INTERNAL	0x0
#endif /* KERNEL */
#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_SVC		0x1
#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_ALL		0x2

#ifndef KERNEL

__BEGIN_DECLS

int pid_suspend(int pid);
int pid_resume(int pid);


__END_DECLS

#endif /* !KERNEL */
#endif /* PRIVATE */

#endif	/* !_SYS_PROC_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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.h 8.15 (Berkeley) 5/19/95
	67	*/
	68
	69	#ifndef _SYS_PROC_H_
	70	#define _SYS_PROC_H_
	71
9bccf70c	72	#include <sys/appleapiopts.h>
1c79356b	73	#include <sys/cdefs.h>
1c79356b A	74	#include <sys/select.h> /* For struct selinfo. */
	75	#include <sys/queue.h>
	76	#include <sys/lock.h>
	77	#include <sys/param.h>
55e303ae	78	#include <sys/event.h>
91447636 A	79	#ifdef KERNEL
	80	#include <sys/kernel_types.h>
	81	#endif
	82	#include <mach/boolean.h>
1c79356b	83
b0d623f7	84	#if defined(XNU_KERNEL_PRIVATE) \|\| !defined(KERNEL)
1c79356b	85
9bccf70c A	86	struct session;
	87	struct pgrp;
	88	struct proc;
9bccf70c	89
1c79356b A	90	/* Exported fields for kern sysctls */
1c79356b A	91	struct extern_proc {
9bccf70c A	92	union {
	93	struct {
	94	struct proc __p_forw; / Doubly-linked run/sleep queue. */
	95	struct proc *__p_back;
	96	} p_st1;
	97	struct timeval __p_starttime; /* process start time */
	98	} p_un;
	99	#define p_forw p_un.p_st1.__p_forw
	100	#define p_back p_un.p_st1.__p_back
	101	#define p_starttime p_un.__p_starttime
1c79356b A	102	struct vmspace p_vmspace; / Address space. */
	103	struct sigacts p_sigacts; / Signal actions, state (PROC ONLY). */
	104	int p_flag; /* P_* flags. */
	105	char p_stat; /* S* process status. */
	106	pid_t p_pid; /* Process identifier. */
	107	pid_t p_oppid; /* Save parent pid during ptrace. XXX */
	108	int p_dupfd; /* Sideways return value from fdopen. XXX */
	109	/* Mach related */
	110	caddr_t user_stack; /* where user stack was allocated */
	111	void exit_thread; / XXX Which thread is exiting? */
	112	int p_debugger; /* allow to debug */
	113	boolean_t sigwait; /* indication to suspend */
	114	/* scheduling */
	115	u_int p_estcpu; /* Time averaged value of p_cpticks. */
	116	int p_cpticks; /* Ticks of cpu time. */
	117	fixpt_t p_pctcpu; /* %cpu for this process during p_swtime */
	118	void p_wchan; / Sleep address. */
	119	char p_wmesg; / Reason for sleep. */
	120	u_int p_swtime; /* Time swapped in or out. */
	121	u_int p_slptime; /* Time since last blocked. */
	122	struct itimerval p_realtimer; /* Alarm timer. */
	123	struct timeval p_rtime; /* Real time. */
	124	u_quad_t p_uticks; /* Statclock hits in user mode. */
	125	u_quad_t p_sticks; /* Statclock hits in system mode. */
	126	u_quad_t p_iticks; /* Statclock hits processing intr. */
	127	int p_traceflag; /* Kernel trace points. */
	128	struct vnode p_tracep; / Trace to vnode. */
b0d623f7	129	int p_siglist; /* DEPRECATED. */
1c79356b A	130	struct vnode p_textvp; / Vnode of executable. */
1c79356b A	131	int p_holdcnt; /* If non-zero, don't swap. */
9bccf70c	132	sigset_t p_sigmask; /* DEPRECATED. */
1c79356b A	133	sigset_t p_sigignore; /* Signals being ignored. */
	134	sigset_t p_sigcatch; /* Signals being caught by user. */
	135	u_char p_priority; /* Process priority. */
	136	u_char p_usrpri; /* User-priority based on p_cpu and p_nice. */
	137	char p_nice; /* Process "nice" value. */
	138	char p_comm[MAXCOMLEN+1];
	139	struct pgrp p_pgrp; / Pointer to process group. */
	140	struct user p_addr; / Kernel virtual addr of u-area (PROC ONLY). */
	141	u_short p_xstat; /* Exit status for wait; also stop signal. */
	142	u_short p_acflag; /* Accounting flags. */
	143	struct rusage p_ru; / Exit information. XXX */
	144	};
	145
1c79356b A	146
	147	/* Status values. */
	148	#define SIDL 1 /* Process being created by fork. */
	149	#define SRUN 2 /* Currently runnable. */
	150	#define SSLEEP 3 /* Sleeping on an address. */
	151	#define SSTOP 4 /* Process debugging or suspension. */
	152	#define SZOMB 5 /* Awaiting collection by parent. */
	153
2d21ac55	154	/* These flags are kept in extern_proc.p_flag. */
91447636 A	155	#define P_ADVLOCK 0x00000001 /* Process may hold POSIX adv. lock */
	156	#define P_CONTROLT 0x00000002 /* Has a controlling terminal */
	157	#define P_LP64 0x00000004 /* Process is LP64 */
	158	#define P_NOCLDSTOP 0x00000008 /* No SIGCHLD when children stop */
	159
	160	#define P_PPWAIT 0x00000010 /* Parent waiting for chld exec/exit */
	161	#define P_PROFIL 0x00000020 /* Has started profiling */
	162	#define P_SELECT 0x00000040 /* Selecting; wakeup/waiting danger */
	163	#define P_CONTINUED 0x00000080 /* Process was stopped and continued */
	164
	165	#define P_SUGID 0x00000100 /* Has set privileges since last exec */
	166	#define P_SYSTEM 0x00000200 /* Sys proc: no sigs, stats or swap */
	167	#define P_TIMEOUT 0x00000400 /* Timing out during sleep */
	168	#define P_TRACED 0x00000800 /* Debugged process being traced */
	169
6d2010ae	170	#define P_DISABLE_ASLR 0x00001000 /* Disable address space layout randomization */
2d21ac55	171	#define P_WEXIT 0x00002000 /* Working on exiting */
91447636	172	#define P_EXEC 0x00004000 /* Process called exec. */
1c79356b	173
1c79356b	174	/* Should be moved to machine-dependent areas. */
91447636	175	#define P_OWEUPC 0x00008000 /* Owe process an addupc() call at next ast. */
1c79356b	176
91447636	177	#define P_AFFINITY 0x00010000 /* xxx */
0c530ab8 A	178	#define P_TRANSLATED 0x00020000 /* xxx */
0c530ab8 A	179	#define P_CLASSIC P_TRANSLATED /* xxx */
55e303ae	180	/*
91447636 A	181	#define P_FSTRACE 0x10000 / * tracing via file system (elsewhere?) * /
91447636 A	182	#define P_SSTEP 0x20000 / * process needs single-step fixup ??? * /
55e303ae	183	*/
1c79356b	184
316670eb	185	#define P_DELAYIDLESLEEP 0x00040000 /* Process is marked to delay idle sleep on disk IO */
2d21ac55	186	#define P_CHECKOPENEVT 0x00080000 /* check if a vnode has the OPENEVT flag set on open */
91447636	187
2d21ac55	188	#define P_DEPENDENCY_CAPABLE 0x00100000 /* process is ok to call vfs_markdependency() */
91447636 A	189	#define P_REBOOT 0x00200000 /* Process called reboot() */
91447636 A	190	#define P_TBE 0x00400000 /* Process is TBE */
2d21ac55	191	#define P_RESV7 0x00800000 /* (P_SIGEXC)signal exceptions */
91447636	192
2d21ac55 A	193	#define P_THCWD 0x01000000 /* process has thread cwd */
	194	#define P_RESV9 0x02000000 /* (P_VFORK)process has vfork children */
	195	#define P_RESV10 0x04000000 /* used to be P_NOATTACH */
	196	#define P_RESV11 0x08000000 /* (P_INVFORK) proc in vfork */
91447636	197
9bccf70c A	198	#define P_NOSHLIB 0x10000000 /* no shared libs are in use for proc */
	199	/* flag set on exec */
	200	#define P_FORCEQUOTA 0x20000000 /* Force quota for root */
	201	#define P_NOCLDWAIT 0x40000000 /* No zombies when chil procs exit */
55e303ae	202	#define P_NOREMOTEHANG 0x80000000 /* Don't hang on remote FS ops */
0b4e3aa0	203
91447636 A	204	#define P_INMEM 0 /* Obsolete: retained for compilation */
	205	#define P_NOSWAP 0 /* Obsolete: retained for compilation */
	206	#define P_PHYSIO 0 /* Obsolete: retained for compilation */
	207	#define P_FSTRACE 0 /* Obsolete: retained for compilation */
	208	#define P_SSTEP 0 /* Obsolete: retained for compilation */
1c79356b	209
316670eb A	210	#define P_DIRTY_TRACK 0x00000001 /* track dirty state */
316670eb A	211	#define P_DIRTY_ALLOW_IDLE_EXIT 0x00000002 /* process can be idle-exited when clean */
39236c6e A	212	#define P_DIRTY_DEFER 0x00000004 /* defer initial opt-in to idle-exit */
	213	#define P_DIRTY 0x00000008 /* process is dirty */
	214	#define P_DIRTY_SHUTDOWN 0x00000010 /* process is dirty during shutdown */
	215	#define P_DIRTY_TERMINATED 0x00000020 /* process has been marked for termination */
	216	#define P_DIRTY_BUSY 0x00000040 /* serialization flag */
	217	#define P_DIRTY_MARKED 0x00000080 /* marked dirty previously */
	218	#define P_DIRTY_DEFER_IN_PROGRESS 0x00000100 /* deferral to idle-band in process */
316670eb	219
316670eb	220	#define P_DIRTY_IS_DIRTY (P_DIRTY \| P_DIRTY_SHUTDOWN)
39236c6e	221	#define P_DIRTY_IDLE_EXIT_ENABLED (P_DIRTY_TRACK\|P_DIRTY_ALLOW_IDLE_EXIT)
316670eb	222
b0d623f7	223	#endif /* XNU_KERNEL_PRIVATE \|\| !KERNEL */
1c79356b A	224
1c79356b A	225	#ifdef KERNEL
1c79356b	226	__BEGIN_DECLS
91447636 A	227
	228	extern proc_t kernproc;
	229
2d21ac55 A	230	extern int proc_is_classic(proc_t p);
2d21ac55 A	231	proc_t current_proc_EXTERNAL(void);
9bccf70c	232
91447636	233	extern int msleep(void chan, lck_mtx_t mtx, int pri, const char wmesg, struct timespec ts );
91447636 A	234	extern void wakeup(void *chan);
	235	extern void wakeup_one(caddr_t chan);
	236
	237	/* proc kpis */
	238	/* this routine returns the pid of the current process */
	239	extern int proc_selfpid(void);
	240	/* this routine returns the pid of the parent of the current process */
	241	extern int proc_selfppid(void);
	242	/* this routine returns sends a signal signum to the process identified by the pid */
	243	extern void proc_signal(int pid, int signum);
	244	/* this routine checks whether any signal identified by the mask are pending in the process identified by the pid. The check is on all threads of the process. */
	245	extern int proc_issignal(int pid, sigset_t mask);
	246	/* this routine returns 1 if the pid1 is inferior of pid2 */
	247	extern int proc_isinferior(int pid1, int pid2);
	248	/* this routine copies the process's name of the executable to the passed in buffer. It
	249	* is always null terminated. The size of the buffer is to be passed in as well. This
	250	* routine is to be used typically for debugging
	251	*/
	252	void proc_name(int pid, char * buf, int size);
	253	/* This routine is simillar to proc_name except it returns for current process */
	254	void proc_selfname(char * buf, int size);
	255
	256	/* find a process with a given pid. This comes with a reference which needs to be dropped by proc_rele */
	257	extern proc_t proc_find(int pid);
	258	/* returns a handle to current process which is referenced. The reference needs to be dropped with proc_rele */
	259	extern proc_t proc_self(void);
	260	/* releases the held reference on the process */
	261	extern int proc_rele(proc_t p);
	262	/* returns the pid of the given process */
	263	extern int proc_pid(proc_t);
	264	/* returns the pid of the parent of a given process */
	265	extern int proc_ppid(proc_t);
	266	/* returns 1 if the process is marked for no remote hangs */
	267	extern int proc_noremotehang(proc_t);
6d2010ae	268	/* returns 1 if the process is marked for force quota */
91447636 A	269	extern int proc_forcequota(proc_t);
	270
	271	/* this routine returns 1 if the process is running with 64bit address space, else 0 */
	272	extern int proc_is64bit(proc_t);
	273	/* is this process exiting? */
	274	extern int proc_exiting(proc_t);
2d21ac55 A	275	/* this routine returns error if the process is not one with super user privileges */
	276	int proc_suser(proc_t p);
	277	/* returns the cred assicaited with the process; temporary api */
	278	kauth_cred_t proc_ucred(proc_t p);
2d21ac55	279
2d21ac55	280	extern int proc_tbe(proc_t);
91447636	281
b0d623f7 A	282	/*!
	283	@function proc_selfpgrpid
	284	@abstract Get the process group id for the current process, as with proc_pgrpid().
	285	@return pgrpid of current process.
	286	*/
	287	pid_t proc_selfpgrpid(void);
	288
	289	/*!
	290	@function proc_pgrpid
	291	@abstract Get the process group id for the passed-in process.
	292	@param p Process whose pgrpid to grab.
	293	@return pgrpid for "p".
	294	*/
	295	pid_t proc_pgrpid(proc_t);
	296
2d21ac55	297	#ifdef KERNEL_PRIVATE
b0d623f7 A	298	// mark a process as being allowed to call vfs_markdependency()
b0d623f7 A	299	void bsd_set_dependency_capable(task_t task);
91447636	300	extern int IS_64BIT_PROCESS(proc_t);
91447636	301
91447636 A	302	extern int tsleep(void chan, int pri, const char wmesg, int timo);
91447636 A	303	extern int msleep1(void chan, lck_mtx_t mtx, int pri, const char *wmesg, u_int64_t timo);
593a1d5f	304
316670eb	305	task_t proc_task(proc_t);
593a1d5f A	306	extern int proc_pidversion(proc_t);
593a1d5f A	307	extern int proc_getcdhash(proc_t, unsigned char *);
39236c6e A	308
	309	/*!
	310	@function proc_pidbackgrounded
	311	@abstract KPI to determine if a process is currently backgrounded.
	312	@discussion The process may move into or out of background state at any time,
	313	so be prepared for this value to be outdated immediately.
	314	@param pid PID of the process to be queried.
	315	@param state Pointer to a value which will be set to 1 if the process
	316	is currently backgrounded, 0 otherwise.
	317	@return ESRCH if pid cannot be found or has started exiting.
	318
	319	EINVAL if state is NULL.
	320	*/
	321	extern int proc_pidbackgrounded(pid_t pid, uint32_t* state);
	322
6d2010ae A	323	/*
	324	* This returns an unique 64bit id of a given process.
	325	* Caller needs to hold proper reference on the
	326	* passed in process strucutre.
	327	*/
	328	extern uint64_t proc_uniqueid(proc_t);
39236c6e A	329
	330	#endif /* KERNEL_PRIVATE */
	331
	332	#ifdef XNU_KERNEL_PRIVATE
	333
	334	/* unique 64bit id for process's original parent */
	335	extern uint64_t proc_puniqueid(proc_t);
	336
6d2010ae	337	extern void proc_getexecutableuuid(proc_t, unsigned char *, unsigned long);
39236c6e A	338
	339	extern uint64_t proc_was_throttled(proc_t);
	340	extern uint64_t proc_did_throttle(proc_t);
	341
6d2010ae	342	#endif /* XNU_KERNEL_PRIVATE*/
1c79356b	343
91447636	344	__END_DECLS
9bccf70c	345
1c79356b A	346	#endif /* KERNEL */
1c79356b A	347
6d2010ae A	348	#ifdef PRIVATE
	349
	350	/* Values for pid_shutdown_sockets */
	351	#ifdef KERNEL
	352	#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_INTERNAL 0x0
	353	#endif /* KERNEL */
	354	#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_SVC 0x1
	355	#define SHUTDOWN_SOCKET_LEVEL_DISCONNECT_ALL 0x2
	356
	357	#ifndef KERNEL
	358
	359	__BEGIN_DECLS
	360
	361	int pid_suspend(int pid);
	362	int pid_resume(int pid);
	363
	364
	365	__END_DECLS
	366
	367	#endif /* !KERNEL */
	368	#endif /* PRIVATE */
	369
1c79356b	370	#endif /* !_SYS_PROC_H_ */