2004-09-27 Roland McGrath <roland@redhat.com>
[kopensolaris-gnu/glibc.git] / posix / sys / wait.h
1 /* Copyright (C) 1991-1994,1996-2001,2003,2004 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, write to the Free
16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17    02111-1307 USA.  */
18
19 /*
20  *      POSIX Standard: 3.2.1 Wait for Process Termination      <sys/wait.h>
21  */
22
23 #ifndef _SYS_WAIT_H
24 #define _SYS_WAIT_H     1
25
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 #include <signal.h>
31 #include <sys/resource.h>
32
33 /* These macros could also be defined in <stdlib.h>.  */
34 #if !defined _STDLIB_H || !defined __USE_XOPEN
35 /* This will define the `W*' macros for the flag
36    bits to `waitpid', `wait3', and `wait4'.  */
37 # include <bits/waitflags.h>
38
39 # ifdef __USE_BSD
40
41 /* Lots of hair to allow traditional BSD use of `union wait'
42    as well as POSIX.1 use of `int' for the status word.  */
43
44 #  if defined __GNUC__ && !defined __cplusplus
45 #   define __WAIT_INT(status)                                                 \
46   (__extension__ ({ union { __typeof(status) __in; int __i; } __u;            \
47                     __u.__in = (status); __u.__i; }))
48 #  else
49 #   define __WAIT_INT(status)   (*(int *) &(status))
50 #  endif
51
52 /* This is the type of the argument to `wait'.  The funky union
53    causes redeclarations with ether `int *' or `union wait *' to be
54    allowed without complaint.  __WAIT_STATUS_DEFN is the type used in
55    the actual function definitions.  */
56
57 #  if !defined __GNUC__ || __GNUC__ < 2 || defined __cplusplus
58 #   define __WAIT_STATUS        void *
59 #   define __WAIT_STATUS_DEFN   void *
60 #  else
61 /* This works in GCC 2.6.1 and later.  */
62 typedef union
63   {
64     union wait *__uptr;
65     int *__iptr;
66   } __WAIT_STATUS __attribute__ ((__transparent_union__));
67 #   define __WAIT_STATUS_DEFN   int *
68 #  endif
69
70 # else /* Don't use BSD.  */
71
72 #  define __WAIT_INT(status)    (status)
73 #  define __WAIT_STATUS         int *
74 #  define __WAIT_STATUS_DEFN    int *
75
76 # endif /* Use BSD.  */
77
78 /* This will define all the `__W*' macros.  */
79 # include <bits/waitstatus.h>
80
81 # define WEXITSTATUS(status)    __WEXITSTATUS(__WAIT_INT(status))
82 # define WTERMSIG(status)       __WTERMSIG(__WAIT_INT(status))
83 # define WSTOPSIG(status)       __WSTOPSIG(__WAIT_INT(status))
84 # define WIFEXITED(status)      __WIFEXITED(__WAIT_INT(status))
85 # define WIFSIGNALED(status)    __WIFSIGNALED(__WAIT_INT(status))
86 # define WIFSTOPPED(status)     __WIFSTOPPED(__WAIT_INT(status))
87 # ifdef __WIFCONTINUED
88 #  define WIFCONTINUED(status)  __WIFCONTINUED(__WAIT_INT(status))
89 # endif
90 #endif  /* <stdlib.h> not included.  */
91
92 #ifdef  __USE_BSD
93 # define WCOREFLAG              __WCOREFLAG
94 # define WCOREDUMP(status)      __WCOREDUMP(__WAIT_INT(status))
95 # define W_EXITCODE(ret, sig)   __W_EXITCODE(ret, sig)
96 # define W_STOPCODE(sig)        __W_STOPCODE(sig)
97 #endif
98
99 /* The following values are used by the `waitid' function.  */
100 #if defined __USE_SVID || defined __USE_XOPEN
101 typedef enum
102 {
103   P_ALL,                /* Wait for any child.  */
104   P_PID,                /* Wait for specified process.  */
105   P_PGID                /* Wait for members of process group.  */
106 } idtype_t;
107 #endif
108
109
110 /* Wait for a child to die.  When one does, put its status in *STAT_LOC
111    and return its process ID.  For errors, return (pid_t) -1.
112
113    This function is a cancellation point and therefore not marked with
114    __THROW.  */
115 extern __pid_t wait (__WAIT_STATUS __stat_loc);
116
117 #ifdef  __USE_BSD
118 /* Special values for the PID argument to `waitpid' and `wait4'.  */
119 # define WAIT_ANY       (-1)    /* Any process.  */
120 # define WAIT_MYPGRP    0       /* Any process in my process group.  */
121 #endif
122
123 /* Wait for a child matching PID to die.
124    If PID is greater than 0, match any process whose process ID is PID.
125    If PID is (pid_t) -1, match any process.
126    If PID is (pid_t) 0, match any process with the
127    same process group as the current process.
128    If PID is less than -1, match any process whose
129    process group is the absolute value of PID.
130    If the WNOHANG bit is set in OPTIONS, and that child
131    is not already dead, return (pid_t) 0.  If successful,
132    return PID and store the dead child's status in STAT_LOC.
133    Return (pid_t) -1 for errors.  If the WUNTRACED bit is
134    set in OPTIONS, return status for stopped children; otherwise don't.
135
136    This function is a cancellation point and therefore not marked with
137    __THROW.  */
138 extern __pid_t waitpid (__pid_t __pid, int *__stat_loc, int __options);
139
140 #if defined __USE_SVID || defined __USE_XOPEN
141 # define __need_siginfo_t
142 # include <bits/siginfo.h>
143 /* Wait for a childing matching IDTYPE and ID to change the status and
144    place appropriate information in *INFOP.
145    If IDTYPE is P_PID, match any process whose process ID is ID.
146    If IDTYPE is P_PGID, match any process whose process group is ID.
147    If IDTYPE is P_ALL, match any process.
148    If the WNOHANG bit is set in OPTIONS, and that child
149    is not already dead, clear *INFOP and return 0.  If successful, store
150    exit code and status in *INFOP.
151
152    This function is a cancellation point and therefore not marked with
153    __THROW.  */
154 extern int waitid (idtype_t __idtype, __id_t __id, siginfo_t *__infop,
155                    int __options);
156 #endif
157
158 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
159 /* This being here makes the prototypes valid whether or not
160    we have already included <sys/resource.h> to define `struct rusage'.  */
161 struct rusage;
162
163 /* Wait for a child to exit.  When one does, put its status in *STAT_LOC and
164    return its process ID.  For errors return (pid_t) -1.  If USAGE is not
165    nil, store information about the child's resource usage there.  If the
166    WUNTRACED bit is set in OPTIONS, return status for stopped children;
167    otherwise don't.  */
168 extern __pid_t wait3 (__WAIT_STATUS __stat_loc, int __options,
169                       struct rusage * __usage) __THROW;
170 #endif
171
172 #ifdef __USE_BSD
173 /* This being here makes the prototypes valid whether or not
174    we have already included <sys/resource.h> to define `struct rusage'.  */
175 struct rusage;
176
177 /* PID is like waitpid.  Other args are like wait3.  */
178 extern __pid_t wait4 (__pid_t __pid, __WAIT_STATUS __stat_loc, int __options,
179                       struct rusage *__usage) __THROW;
180 #endif /* Use BSD.  */
181
182
183 __END_DECLS
184
185 #endif /* sys/wait.h  */