1 /* Copyright (C) 1991-2021 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3 
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8 
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13 
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, see
16    <https://www.gnu.org/licenses/>.  */
17 
18 /*
19  *	POSIX Standard: 3.2.1 Wait for Process Termination	<sys/wait.h>
20  */
21 
22 #ifndef	_SYS_WAIT_H
23 #define	_SYS_WAIT_H	1
24 
25 #include <features.h>
26 
27 __BEGIN_DECLS
28 
29 #include <bits/types.h>
30 #ifndef __pid_t_defined
31 typedef __pid_t pid_t;
32 # define __pid_t_defined
33 #endif
34 
35 #if defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
36 # include <signal.h>
37 #endif
38 
39 #if defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K8
40 /* Some older standards require the contents of struct rusage to be
41    defined here.  */
42 # include <bits/types/struct_rusage.h>
43 #endif
44 
45 /* These macros could also be defined in <stdlib.h>.  */
46 #if !defined _STDLIB_H || (!defined __USE_XOPEN && !defined __USE_XOPEN2K8)
47 /* This will define the `W*' macros for the flag
48    bits to `waitpid', `wait3', and `wait4'.  */
49 # include <bits/waitflags.h>
50 
51 /* This will define all the `__W*' macros.  */
52 # include <bits/waitstatus.h>
53 
54 # define WEXITSTATUS(status)	__WEXITSTATUS (status)
55 # define WTERMSIG(status)	__WTERMSIG (status)
56 # define WSTOPSIG(status)	__WSTOPSIG (status)
57 # define WIFEXITED(status)	__WIFEXITED (status)
58 # define WIFSIGNALED(status)	__WIFSIGNALED (status)
59 # define WIFSTOPPED(status)	__WIFSTOPPED (status)
60 # ifdef __WIFCONTINUED
61 #  define WIFCONTINUED(status)	__WIFCONTINUED (status)
62 # endif
63 #endif	/* <stdlib.h> not included.  */
64 
65 #ifdef	__USE_MISC
66 # define WCOREFLAG		__WCOREFLAG
67 # define WCOREDUMP(status)	__WCOREDUMP (status)
68 # define W_EXITCODE(ret, sig)	__W_EXITCODE (ret, sig)
69 # define W_STOPCODE(sig)	__W_STOPCODE (sig)
70 #endif
71 
72 /* The following values are used by the `waitid' function.  */
73 #if defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
74 typedef enum
75 {
76   P_ALL,		/* Wait for any child.  */
77   P_PID,		/* Wait for specified process.  */
78   P_PGID		/* Wait for members of process group.  */
79 } idtype_t;
80 #endif
81 
82 
83 /* Wait for a child to die.  When one does, put its status in *STAT_LOC
84    and return its process ID.  For errors, return (pid_t) -1.
85 
86    This function is a cancellation point and therefore not marked with
87    __THROW.  */
88 extern __pid_t wait (int *__stat_loc);
89 
90 #ifdef	__USE_MISC
91 /* Special values for the PID argument to `waitpid' and `wait4'.  */
92 # define WAIT_ANY	(-1)	/* Any process.  */
93 # define WAIT_MYPGRP	0	/* Any process in my process group.  */
94 #endif
95 
96 /* Wait for a child matching PID to die.
97    If PID is greater than 0, match any process whose process ID is PID.
98    If PID is (pid_t) -1, match any process.
99    If PID is (pid_t) 0, match any process with the
100    same process group as the current process.
101    If PID is less than -1, match any process whose
102    process group is the absolute value of PID.
103    If the WNOHANG bit is set in OPTIONS, and that child
104    is not already dead, return (pid_t) 0.  If successful,
105    return PID and store the dead child's status in STAT_LOC.
106    Return (pid_t) -1 for errors.  If the WUNTRACED bit is
107    set in OPTIONS, return status for stopped children; otherwise don't.
108 
109    This function is a cancellation point and therefore not marked with
110    __THROW.  */
111 extern __pid_t waitpid (__pid_t __pid, int *__stat_loc, int __options);
112 
113 #if defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
114 # ifndef __id_t_defined
115 typedef __id_t id_t;
116 #  define __id_t_defined
117 # endif
118 
119 # include <bits/types/siginfo_t.h>
120 
121 /* Wait for a childing matching IDTYPE and ID to change the status and
122    place appropriate information in *INFOP.
123    If IDTYPE is P_PID, match any process whose process ID is ID.
124    If IDTYPE is P_PGID, match any process whose process group is ID.
125    If IDTYPE is P_ALL, match any process.
126    If the WNOHANG bit is set in OPTIONS, and that child
127    is not already dead, clear *INFOP and return 0.  If successful, store
128    exit code and status in *INFOP.
129 
130    This function is a cancellation point and therefore not marked with
131    __THROW.  */
132 extern int waitid (idtype_t __idtype, __id_t __id, siginfo_t *__infop,
133 		   int __options);
134 #endif
135 
136 #if defined __USE_MISC \
137     || (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K)
138 /* This being here makes the prototypes valid whether or not
139    we have already included <sys/resource.h> to define `struct rusage'.  */
140 struct rusage;
141 
142 /* Wait for a child to exit.  When one does, put its status in *STAT_LOC and
143    return its process ID.  For errors return (pid_t) -1.  If USAGE is not
144    nil, store information about the child's resource usage there.  If the
145    WUNTRACED bit is set in OPTIONS, return status for stopped children;
146    otherwise don't.  */
147 # ifndef __USE_TIME_BITS64
148 extern __pid_t wait3 (int *__stat_loc, int __options,
149 		      struct rusage * __usage) __THROWNL;
150 # else
151 #  ifdef __REDIRECT_NTHNL
152 extern __pid_t __REDIRECT_NTHNL (wait3, (int *__stat_loc, int __options,
153                                          struct rusage * __usage),
154                                  __wait3_time64);
155 #  else
156 #   define wait3 __wait3_time64
157 #  endif
158 # endif
159 #endif
160 
161 #ifdef __USE_MISC
162 # ifndef __USE_TIME_BITS64
163 /* PID is like waitpid.  Other args are like wait3.  */
164 extern __pid_t wait4 (__pid_t __pid, int *__stat_loc, int __options,
165 		      struct rusage *__usage) __THROWNL;
166 # else
167 #  ifdef __REDIRECT_NTHNL
168 extern __pid_t __REDIRECT_NTHNL (wait4, (__pid_t __pid, int *__stat_loc,
169                                          int __options, struct rusage *__usage),
170                                  __wait4_time64);
171 #  else
172 #   define wait4 __wait4_time64
173 #  endif
174 # endif
175 #endif /* Use misc.  */
176 
177 
178 __END_DECLS
179 
180 #endif /* sys/wait.h  */
181