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

/*
 * Copyright (c) 2000 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 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1989, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * 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.
 *
 *	@(#)wait.h	8.2 (Berkeley) 7/10/94
 */
 
#ifndef _SYS_WAIT_H_
#define	_SYS_WAIT_H_

#include <sys/cdefs.h>
#include <sys/_types.h>

/*
 * This file holds definitions relevent to the wait4 system call
 * and the alternate interfaces that use it (wait, wait3, waitpid).
 */

/*
 * [XSI] The type idtype_t shall be defined as an enumeration type whose
 * possible values shall include at least P_ALL, P_PID, and P_PGID.
 */
typedef enum {
	P_ALL,
	P_PID,
	P_PGID
} idtype_t;

/*
 * [XSI] The id_t and pid_t types shall be defined as described
 * in <sys/types.h>
 */
#ifndef _PID_T
typedef __darwin_pid_t	pid_t;
#define _PID_T
#endif

#ifndef _ID_T
typedef __darwin_id_t	id_t;
#define _ID_T
#endif

/*
 * [XSI] The siginfo_t type shall be defined as described in <signal.h>
 * [XSI] The rusage structure shall be defined as described in <sys/resource.h>
 * [XSI] Inclusion of the <sys/wait.h> header may also make visible all
 * symbols from <signal.h> and <sys/resource.h>
 *
 * NOTE:	This requirement is currently being satisfied by the direct
 *		inclusion of <sys/signal.h> and <sys/resource.h>, below.
 *
 *		Software should not depend on the exposure of anything other
 *		than the types siginfo_t and struct rusage as a result of
 *		this inclusion.  If you depend on any types or manifest
 *		values othe than siginfo_t and struct rusage from either of
 *		those files, you should explicitly include them yourself, as
 *		well, or in future releases your stware may not compile
 *		without modification.
 */
#include <sys/signal.h>		/* [XSI] for siginfo_t */
#include <sys/resource.h>	/* [XSI] for struct rusage */

/*
 * Option bits for the third argument of wait4.  WNOHANG causes the
 * wait to not hang if there are no stopped or terminated processes, rather
 * returning an error indication in this case (pid==0).  WUNTRACED
 * indicates that the caller should receive status about untraced children
 * which stop due to signals.  If children are stopped and a wait without
 * this option is done, it is as though they were still running... nothing
 * about them is returned.
 */
#define WNOHANG		0x01	/* [XSI] don't hang in wait/no child to reap */
#define WUNTRACED	0x02	/* [XSI] notify on stopped, untraced children */

/*
 * Macros to test the exit status returned by wait
 * and extract the relevant values.
 */
#ifdef _POSIX_C_SOURCE
#define	_W_INT(i)	(i)
#else
#define	_W_INT(w)	(*(int *)&(w))	/* convert union wait to int */
#define	WCOREFLAG	0200
#endif /* _POSIX_C_SOURCE */

/* These macros are permited, as they are in the implementation namespace */
#define	_WSTATUS(x)	(_W_INT(x) & 0177)
#define	_WSTOPPED	0177		/* _WSTATUS if process is stopped */

/*
 * [XSI] The <sys/wait.h> header shall define the following macros for
 * analysis of process status values
 */
#define WEXITSTATUS(x)	(_W_INT(x) >> 8)
#define WIFCONTINUED(x) (x == 0x13)	/* 0x13 == SIGCONT */
#define WIFEXITED(x)	(_WSTATUS(x) == 0)
#define WIFSIGNALED(x)	(_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
#define WIFSTOPPED(x)	(_WSTATUS(x) == _WSTOPPED)
#define WSTOPSIG(x)	(_W_INT(x) >> 8)
#define WTERMSIG(x)	(_WSTATUS(x))
#if !defined(_POSIX_C_SOURCE)
#define WCOREDUMP(x)	(_W_INT(x) & WCOREFLAG)

#define	W_EXITCODE(ret, sig)	((ret) << 8 | (sig))
#define	W_STOPCODE(sig)		((sig) << 8 | _WSTOPPED)
#endif /* !defined(_POSIX_C_SOURCE) */

/*
 * [XSI] The following symbolic constants shall be defined as possible
 * values for the fourth argument to waitid().
 */
/* WNOHANG already defined for wait4() */
/* WUNTRACED defined for wait4() but not for waitid() */
#define	WEXITED		0x04	/* [XSI] Processes which have exitted */
#ifdef _POSIX_C_SOURCE
/* waitid() parameter */
#define	WSTOPPED	0x08	/* [XSI] Any child stopped by signal receipt */
#endif
#define	WCONTINUED	0x10	/* [XSI] Any child stopped then continued */
#define	WNOWAIT		0x20	/* [XSI] Leave process returned waitable */


#if !defined(_POSIX_C_SOURCE)
/* POSIX extensions and 4.2/4.3 compatability: */

/*
 * Tokens for special values of the "pid" parameter to wait4.
 */
#define	WAIT_ANY	(-1)	/* any process */
#define	WAIT_MYPGRP	0	/* any process in my process group */

#include <machine/endian.h>

/*
 * Deprecated:
 * Structure of the information in the status word returned by wait4.
 * If w_stopval==WSTOPPED, then the second structure describes
 * the information returned, else the first.
 */
union wait {
	int	w_status;		/* used in syscall */
	/*
	 * Terminated process status.
	 */
	struct {
#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN 
		unsigned int	w_Termsig:7,	/* termination signal */
				w_Coredump:1,	/* core dump indicator */
				w_Retcode:8,	/* exit code if w_termsig==0 */
				w_Filler:16;	/* upper bits filler */
#endif
#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN 
		unsigned int	w_Filler:16,	/* upper bits filler */
				w_Retcode:8,	/* exit code if w_termsig==0 */
				w_Coredump:1,	/* core dump indicator */
				w_Termsig:7;	/* termination signal */
#endif
	} w_T;
	/*
	 * Stopped process status.  Returned
	 * only for traced children unless requested
	 * with the WUNTRACED option bit.
	 */
	struct {
#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN 
		unsigned int	w_Stopval:8,	/* == W_STOPPED if stopped */
				w_Stopsig:8,	/* signal that stopped us */
				w_Filler:16;	/* upper bits filler */
#endif
#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN 
		unsigned int	w_Filler:16,	/* upper bits filler */
				w_Stopsig:8,	/* signal that stopped us */
				w_Stopval:8;	/* == W_STOPPED if stopped */
#endif
	} w_S;
};
#define	w_termsig	w_T.w_Termsig
#define w_coredump	w_T.w_Coredump
#define w_retcode	w_T.w_Retcode
#define w_stopval	w_S.w_Stopval
#define w_stopsig	w_S.w_Stopsig

/*
 * Stopped state value; cannot use waitid() parameter of the same name
 * in the same scope
 */
#define	WSTOPPED	_WSTOPPED
#endif /* !defined(_POSIX_C_SOURCE) */

#ifndef KERNEL
__BEGIN_DECLS
pid_t	wait(int *);
pid_t	waitpid(pid_t, int *, int);
#ifndef _ANSI_SOURCE
int	waitid(idtype_t, id_t, siginfo_t *, int);
#endif /* !_ANSI_SOURCE */
#if  !defined(_POSIX_C_SOURCE)
pid_t	wait3(int *, int, struct rusage *);
pid_t	wait4(pid_t, int *, int, struct rusage *);
#endif /* !defined(_POSIX_C_SOURCE) */
__END_DECLS
#endif
#endif /* !_SYS_WAIT_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 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.
	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
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1982, 1986, 1989, 1993, 1994
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)wait.h 8.2 (Berkeley) 7/10/94
	62	*/
	63
	64	#ifndef _SYS_WAIT_H_
	65	#define _SYS_WAIT_H_
	66
91447636 A	67	#include <sys/cdefs.h>
	68	#include <sys/_types.h>
	69
1c79356b A	70	/*
	71	* This file holds definitions relevent to the wait4 system call
	72	* and the alternate interfaces that use it (wait, wait3, waitpid).
	73	*/
	74
91447636 A	75	/*
	76	* [XSI] The type idtype_t shall be defined as an enumeration type whose
	77	* possible values shall include at least P_ALL, P_PID, and P_PGID.
	78	*/
	79	typedef enum {
	80	P_ALL,
	81	P_PID,
	82	P_PGID
	83	} idtype_t;
	84
	85	/*
	86	* [XSI] The id_t and pid_t types shall be defined as described
	87	* in <sys/types.h>
	88	*/
	89	#ifndef _PID_T
	90	typedef __darwin_pid_t pid_t;
	91	#define _PID_T
	92	#endif
	93
	94	#ifndef _ID_T
	95	typedef __darwin_id_t id_t;
	96	#define _ID_T
	97	#endif
	98
	99	/*
	100	* [XSI] The siginfo_t type shall be defined as described in <signal.h>
	101	* [XSI] The rusage structure shall be defined as described in <sys/resource.h>
	102	* [XSI] Inclusion of the <sys/wait.h> header may also make visible all
	103	* symbols from <signal.h> and <sys/resource.h>
	104	*
	105	* NOTE: This requirement is currently being satisfied by the direct
	106	* inclusion of <sys/signal.h> and <sys/resource.h>, below.
	107	*
	108	* Software should not depend on the exposure of anything other
	109	* than the types siginfo_t and struct rusage as a result of
	110	* this inclusion. If you depend on any types or manifest
	111	* values othe than siginfo_t and struct rusage from either of
	112	* those files, you should explicitly include them yourself, as
	113	* well, or in future releases your stware may not compile
	114	* without modification.
	115	*/
	116	#include <sys/signal.h> /* [XSI] for siginfo_t */
	117	#include <sys/resource.h> /* [XSI] for struct rusage */
	118
	119	/*
	120	* Option bits for the third argument of wait4. WNOHANG causes the
	121	* wait to not hang if there are no stopped or terminated processes, rather
	122	* returning an error indication in this case (pid==0). WUNTRACED
	123	* indicates that the caller should receive status about untraced children
	124	* which stop due to signals. If children are stopped and a wait without
	125	* this option is done, it is as though they were still running... nothing
	126	* about them is returned.
	127	*/
	128	#define WNOHANG 0x01 /* [XSI] don't hang in wait/no child to reap */
	129	#define WUNTRACED 0x02 /* [XSI] notify on stopped, untraced children */
	130
1c79356b A	131	/*
	132	* Macros to test the exit status returned by wait
	133	* and extract the relevant values.
	134	*/
91447636	135	#ifdef _POSIX_C_SOURCE
1c79356b A	136	#define _W_INT(i) (i)
	137	#else
	138	#define _W_INT(w) ((int )&(w)) /* convert union wait to int */
	139	#define WCOREFLAG 0200
91447636	140	#endif /* _POSIX_C_SOURCE */
1c79356b	141
91447636	142	/* These macros are permited, as they are in the implementation namespace */
1c79356b A	143	#define _WSTATUS(x) (_W_INT(x) & 0177)
1c79356b A	144	#define _WSTOPPED 0177 /* _WSTATUS if process is stopped */
91447636 A	145
	146	/*
	147	* [XSI] The <sys/wait.h> header shall define the following macros for
	148	* analysis of process status values
	149	*/
	150	#define WEXITSTATUS(x) (_W_INT(x) >> 8)
	151	#define WIFCONTINUED(x) (x == 0x13) /* 0x13 == SIGCONT */
	152	#define WIFEXITED(x) (_WSTATUS(x) == 0)
	153	#define WIFSIGNALED(x) (_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
1c79356b A	154	#define WIFSTOPPED(x) (_WSTATUS(x) == _WSTOPPED)
1c79356b A	155	#define WSTOPSIG(x) (_W_INT(x) >> 8)
1c79356b	156	#define WTERMSIG(x) (_WSTATUS(x))
91447636	157	#if !defined(_POSIX_C_SOURCE)
1c79356b A	158	#define WCOREDUMP(x) (_W_INT(x) & WCOREFLAG)
	159
	160	#define W_EXITCODE(ret, sig) ((ret) << 8 \| (sig))
	161	#define W_STOPCODE(sig) ((sig) << 8 \| _WSTOPPED)
91447636	162	#endif /* !defined(_POSIX_C_SOURCE) */
1c79356b A	163
1c79356b A	164	/*
91447636 A	165	* [XSI] The following symbolic constants shall be defined as possible
91447636 A	166	* values for the fourth argument to waitid().
1c79356b	167	*/
91447636 A	168	/* WNOHANG already defined for wait4() */
	169	/* WUNTRACED defined for wait4() but not for waitid() */
	170	#define WEXITED 0x04 /* [XSI] Processes which have exitted */
	171	#ifdef _POSIX_C_SOURCE
	172	/* waitid() parameter */
	173	#define WSTOPPED 0x08 /* [XSI] Any child stopped by signal receipt */
	174	#endif
	175	#define WCONTINUED 0x10 /* [XSI] Any child stopped then continued */
	176	#define WNOWAIT 0x20 /* [XSI] Leave process returned waitable */
	177
1c79356b	178
91447636	179	#if !defined(_POSIX_C_SOURCE)
1c79356b A	180	/* POSIX extensions and 4.2/4.3 compatability: */
	181
	182	/*
	183	* Tokens for special values of the "pid" parameter to wait4.
	184	*/
	185	#define WAIT_ANY (-1) /* any process */
	186	#define WAIT_MYPGRP 0 /* any process in my process group */
	187
	188	#include <machine/endian.h>
	189
	190	/*
	191	* Deprecated:
	192	* Structure of the information in the status word returned by wait4.
	193	* If w_stopval==WSTOPPED, then the second structure describes
	194	* the information returned, else the first.
	195	*/
	196	union wait {
	197	int w_status; /* used in syscall */
	198	/*
	199	* Terminated process status.
	200	*/
	201	struct {
91447636	202	#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
1c79356b A	203	unsigned int w_Termsig:7, /* termination signal */
	204	w_Coredump:1, /* core dump indicator */
	205	w_Retcode:8, /* exit code if w_termsig==0 */
	206	w_Filler:16; /* upper bits filler */
	207	#endif
91447636	208	#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
1c79356b A	209	unsigned int w_Filler:16, /* upper bits filler */
	210	w_Retcode:8, /* exit code if w_termsig==0 */
	211	w_Coredump:1, /* core dump indicator */
	212	w_Termsig:7; /* termination signal */
	213	#endif
	214	} w_T;
	215	/*
	216	* Stopped process status. Returned
	217	* only for traced children unless requested
	218	* with the WUNTRACED option bit.
	219	*/
	220	struct {
91447636	221	#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
1c79356b A	222	unsigned int w_Stopval:8, /* == W_STOPPED if stopped */
	223	w_Stopsig:8, /* signal that stopped us */
	224	w_Filler:16; /* upper bits filler */
	225	#endif
91447636	226	#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
1c79356b A	227	unsigned int w_Filler:16, /* upper bits filler */
	228	w_Stopsig:8, /* signal that stopped us */
	229	w_Stopval:8; /* == W_STOPPED if stopped */
	230	#endif
	231	} w_S;
	232	};
	233	#define w_termsig w_T.w_Termsig
	234	#define w_coredump w_T.w_Coredump
	235	#define w_retcode w_T.w_Retcode
	236	#define w_stopval w_S.w_Stopval
	237	#define w_stopsig w_S.w_Stopsig
	238
91447636 A	239	/*
	240	* Stopped state value; cannot use waitid() parameter of the same name
	241	* in the same scope
	242	*/
1c79356b	243	#define WSTOPPED _WSTOPPED
91447636	244	#endif /* !defined(_POSIX_C_SOURCE) */
1c79356b A	245
1c79356b A	246	#ifndef KERNEL
1c79356b	247	__BEGIN_DECLS
91447636 A	248	pid_t wait(int *);
	249	pid_t waitpid(pid_t, int *, int);
	250	#ifndef _ANSI_SOURCE
	251	int waitid(idtype_t, id_t, siginfo_t *, int);
	252	#endif /* !_ANSI_SOURCE */
	253	#if !defined(_POSIX_C_SOURCE)
	254	pid_t wait3(int , int, struct rusage );
	255	pid_t wait4(pid_t, int , int, struct rusage );
	256	#endif /* !defined(_POSIX_C_SOURCE) */
1c79356b A	257	__END_DECLS
	258	#endif
	259	#endif /* !_SYS_WAIT_H_ */