xref: /freebsd/sys/sys/wait.h (revision 7bd6fde3)
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)wait.h	8.2 (Berkeley) 7/10/94
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_WAIT_H_
34 #define _SYS_WAIT_H_
35 
36 #include <sys/cdefs.h>
37 
38 /*
39  * This file holds definitions relevant to the wait4 system call and the
40  * alternate interfaces that use it (wait, wait3, waitpid).
41  */
42 
43 /*
44  * Macros to test the exit status returned by wait and extract the relevant
45  * values.
46  */
47 #if __BSD_VISIBLE
48 #define	WCOREFLAG	0200
49 #endif
50 #define	_W_INT(i)	(i)
51 
52 #define	_WSTATUS(x)	(_W_INT(x) & 0177)
53 #define	_WSTOPPED	0177		/* _WSTATUS if process is stopped */
54 #define	WIFSTOPPED(x)	(_WSTATUS(x) == _WSTOPPED)
55 #define	WSTOPSIG(x)	(_W_INT(x) >> 8)
56 #define	WIFSIGNALED(x)	(_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
57 #define	WTERMSIG(x)	(_WSTATUS(x))
58 #define	WIFEXITED(x)	(_WSTATUS(x) == 0)
59 #define	WEXITSTATUS(x)	(_W_INT(x) >> 8)
60 #define	WIFCONTINUED(x)	(x == 0x13)	/* 0x13 == SIGCONT */
61 #if __BSD_VISIBLE
62 #define	WCOREDUMP(x)	(_W_INT(x) & WCOREFLAG)
63 
64 #define	W_EXITCODE(ret, sig)	((ret) << 8 | (sig))
65 #define	W_STOPCODE(sig)		((sig) << 8 | _WSTOPPED)
66 #endif
67 
68 /*
69  * Option bits for the third argument of wait4.  WNOHANG causes the
70  * wait to not hang if there are no stopped or terminated processes, rather
71  * returning an error indication in this case (pid==0).  WUNTRACED
72  * indicates that the caller should receive status about untraced children
73  * which stop due to signals.  If children are stopped and a wait without
74  * this option is done, it is as though they were still running... nothing
75  * about them is returned.
76  */
77 #define	WNOHANG		1	/* Don't hang in wait. */
78 #define	WUNTRACED	2	/* Tell about stopped, untraced children. */
79 #define	WCONTINUED	4	/* Report a job control continued process. */
80 
81 #if __BSD_VISIBLE
82 #define	WLINUXCLONE 0x80000000	/* Wait for kthread spawned from linux_clone. */
83 #endif
84 
85 /*
86  * Tokens for special values of the "pid" parameter to wait4.
87  */
88 #if __BSD_VISIBLE
89 #define	WAIT_ANY	(-1)	/* any process */
90 #define	WAIT_MYPGRP	0	/* any process in my process group */
91 #endif /* __BSD_VISIBLE */
92 
93 #ifndef _KERNEL
94 #include <sys/types.h>
95 
96 __BEGIN_DECLS
97 pid_t	wait(int *);
98 pid_t	waitpid(pid_t, int *, int);
99 #if __BSD_VISIBLE
100 struct rusage;
101 pid_t	wait3(int *, int, struct rusage *);
102 pid_t	wait4(pid_t, int *, int, struct rusage *);
103 #endif
104 __END_DECLS
105 #endif /* !_KERNEL */
106 
107 #endif /* !_SYS_WAIT_H_ */
108