1 /*	$NetBSD: wait.h,v 1.31 2016/07/07 06:55:44 msaitoh Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1989, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)wait.h	8.2 (Berkeley) 7/10/94
32  */
33 
34 #ifndef _SYS_WAIT_H_
35 #define _SYS_WAIT_H_
36 
37 #include <sys/featuretest.h>
38 #include <sys/types.h>
39 #include <sys/sigtypes.h>
40 #include <sys/siginfo.h>
41 #include <sys/idtype.h>
42 
43 /*
44  * This file holds definitions relevent to the wait4 system call
45  * and the alternate interfaces that use it (wait, wait3, waitpid).
46  */
47 
48 /*
49  * Macros to test the exit status returned by wait
50  * and extract the relevant values.
51  */
52 #if !( defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) ) || defined(_KERNEL)
53 #define	_W_INT(i)	(i)
54 #else
55 #define	_W_INT(w)	(*(int *)(void *)&(w))	/* convert union wait to int */
56 #endif
57 
58 #define	_WSTATUS(x)	(_W_INT(x) & 0177)
59 #define	_WSTOPPED	0177		/* _WSTATUS if process is stopped */
60 #define _WCONTINUED	0xffffU
61 #define WIFSTOPPED(x)	(_WSTATUS(x) == _WSTOPPED)
62 #define WIFCONTINUED(x)	(_W_INT(x) == _WCONTINUED)
63 #define WSTOPSIG(x)	((int)(((unsigned int)_W_INT(x)) >> 8) & 0xff)
64 #define WIFSIGNALED(x)	(_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
65 #define WTERMSIG(x)	(_WSTATUS(x))
66 #define WIFEXITED(x)	(_WSTATUS(x) == 0)
67 #define WEXITSTATUS(x)	((int)(((unsigned int)_W_INT(x)) >> 8) & 0xff)
68 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) || defined(_KERNEL)
69 #define	WCOREFLAG	0200
70 #define WCOREDUMP(x)	(_W_INT(x) & WCOREFLAG)
71 
72 #define	W_EXITCODE(ret, sig)	((ret) << 8 | (sig))
73 #define	W_STOPCODE(sig)		((sig) << 8 | _WSTOPPED)
74 #define	W_CONTCODE()		(_WCONTINUED)
75 #endif
76 
77 /*
78  * Option bits for the third argument of wait4.  WNOHANG causes the
79  * wait to not hang if there are no stopped or terminated processes, rather
80  * returning an error indication in this case (pid==0).  WUNTRACED
81  * indicates that the caller should receive status about untraced children
82  * which stop due to signals.  If children are stopped and a wait without
83  * this option is done, it is as though they were still running... nothing
84  * about them is returned.
85  */
86 #define WNOHANG		0x00000001	/* don't hang in wait */
87 #define WUNTRACED	0x00000002	/* tell about stopped,
88 					   untraced children */
89 #define	WSTOPPED	WUNTRACED	/* SUS compatibility */
90 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
91 #define	WALTSIG		0x00000004	/* wait for processes that exit
92 					   with an alternate signal (i.e.
93 					   not SIGCHLD) */
94 #define	WALLSIG		0x00000008	/* wait for processes that exit
95 					   with any signal, i.e. SIGCHLD
96 					   and alternates */
97 #define	WCONTINUED	0x00000010	/* Report a job control continued
98 					   process. */
99 #define	WEXITED		0x00000020	/* Wait for exited processes. */
100 #define	WTRAPPED	0x00000040	/* Wait for a process to hit a trap or
101 				 	   a breakpoint. */
102 
103 /*
104  * These are the Linux names of some of the above flags, for compatibility
105  * with Linux's clone(2) API.
106  */
107 #define	__WCLONE	WALTSIG
108 #define	__WALL		WALLSIG
109 
110 /*
111  * These bits are used in order to support SVR4 (etc) functionality
112  * without replicating sys_wait4 5 times.
113  */
114 #define	WNOWAIT		0x00010000	/* Don't mark child 'P_WAITED' */
115 #define	WNOZOMBIE	0x00020000	/* Ignore zombies */
116 #define	WOPTSCHECKED	0x00040000	/* Compat call, options verified */
117 #endif /* _XOPEN_SOURCE || _NETBSD_SOURCE */
118 
119 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
120 /* POSIX extensions and 4.2/4.3 compatibility: */
121 
122 /*
123  * Tokens for special values of the "pid" parameter to wait4.
124  */
125 #define	WAIT_ANY	(-1)	/* any process */
126 #define	WAIT_MYPGRP	0	/* any process in my process group */
127 
128 #include <sys/types.h>
129 
130 /*
131  * Deprecated:
132  * Structure of the information in the status word returned by wait4.
133  * If w_stopval==WSTOPPED, then the second structure describes
134  * the information returned, else the first.
135  */
136 union wait {
137 	int	w_status;		/* used in syscall */
138 	/*
139 	 * Terminated process status.
140 	 */
141 	struct {
142 #if BYTE_ORDER == LITTLE_ENDIAN
143 		unsigned int	w_Termsig:7,	/* termination signal */
144 				w_Coredump:1,	/* core dump indicator */
145 				w_Retcode:8,	/* exit code if w_termsig==0 */
146 				w_Filler:16;	/* upper bits filler */
147 #endif
148 #if BYTE_ORDER == BIG_ENDIAN
149 		unsigned int	w_Filler:16,	/* upper bits filler */
150 				w_Retcode:8,	/* exit code if w_termsig==0 */
151 				w_Coredump:1,	/* core dump indicator */
152 				w_Termsig:7;	/* termination signal */
153 #endif
154 	} w_T;
155 	/*
156 	 * Stopped process status.  Returned
157 	 * only for traced children unless requested
158 	 * with the WUNTRACED option bit.
159 	 */
160 	struct {
161 #if BYTE_ORDER == LITTLE_ENDIAN
162 		unsigned int	w_Stopval:8,	/* == W_STOPPED if stopped */
163 				w_Stopsig:8,	/* signal that stopped us */
164 				w_Filler:16;	/* upper bits filler */
165 #endif
166 #if BYTE_ORDER == BIG_ENDIAN
167 		unsigned int	w_Filler:16,	/* upper bits filler */
168 				w_Stopsig:8,	/* signal that stopped us */
169 				w_Stopval:8;	/* == W_STOPPED if stopped */
170 #endif
171 	} w_S;
172 };
173 #define	w_termsig	w_T.w_Termsig
174 #define w_coredump	w_T.w_Coredump
175 #define w_retcode	w_T.w_Retcode
176 #define w_stopval	w_S.w_Stopval
177 #define w_stopsig	w_S.w_Stopsig
178 
179 #endif /* _XOPEN_SOURCE || _NETBSD_SOURCE */
180 
181 #ifndef _KERNEL
182 #include <sys/cdefs.h>
183 
184 __BEGIN_DECLS
185 struct rusage;	/* forward declaration */
186 struct wrusage;
187 
188 pid_t	wait(int *);
189 pid_t	waitpid(pid_t, int *, int);
190 int	waitid(idtype_t, id_t, siginfo_t *, int);
191 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
192 #ifndef __LIBC12_SOURCE__
193 pid_t	wait3(int *, int, struct rusage *) __RENAME(__wait350);
194 pid_t	wait4(pid_t, int *, int, struct rusage *) __RENAME(__wait450);
195 pid_t	wait6(idtype_t, id_t, int *, int, struct wrusage *, siginfo_t *);
196 #endif
197 #endif
198 __END_DECLS
199 #endif
200 
201 #endif /* !_SYS_WAIT_H_ */
202