[GCC>=2.6] (__WAIT_STATUS): Define this with typedef as a union with the
[kopensolaris-gnu/glibc.git] / posix / sys / wait.h
1 /* Copyright (C) 1991, 1992, 1993, 1994 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 Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 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 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the, 1992 Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      POSIX Standard: 3.2.1 Wait for Process Termination      <sys/wait.h>
21  */
22
23 #ifndef _SYS_WAIT_H
24
25 #define _SYS_WAIT_H     1
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 #include <gnu/types.h>
31
32 /* This will define the `W*' macros for the flag
33    bits to `waitpid', `wait3', and `wait4'.  */
34 #include <waitflags.h>
35
36 #ifdef  __USE_BSD
37
38 /* Lots of hair to allow traditional BSD use of `union wait'
39    as well as POSIX.1 use of `int' for the status word.  */
40
41 #ifdef  __GNUC__
42 #define __WAIT_INT(status)                                                    \
43   (__extension__ ({ union { __typeof(status) __in; int __i; } __u;            \
44                     __u.__in = (status); __u.__i; }))
45 #else
46 #define __WAIT_INT(status)      (*(int *) &(status))
47 #endif
48
49 /* This is the type of the argument to `wait'.  With GCC 2.6.1 and later,
50    the funky union causes redeclarations with either `int *' or `union wait
51    *' to be allowed without complaint.  __WAIT_STATUS_DEFN is the type used
52    in the actual function definitions. */
53
54 #if     (!defined (__GNUC__) || __GNUC__ < 2 || \
55          (__GNUC__ == 2 && __GNUC_MINOR__ < 6))
56 #define __WAIT_STATUS           __ptr_t
57 #define __WAIT_STATUS_DEFN      __ptr_t
58 #else
59 /* This works in GCC 2.6.1 and later.  */
60 typedef union
61   {
62     union wait *__uptr;
63     int *__iptr;
64   } __attribute__ ((transparent_union)) __WAIT_STATUS;
65 #define __WAIT_STATUS_DEFN      int *
66 #endif
67
68 #else /* Don't use BSD.  */
69
70 #define __WAIT_INT(status)      (status)
71 #define __WAIT_STATUS           int *
72 #define __WAIT_STATUS_DEFN      int *
73
74 #endif /* Use BSD.  */
75
76 /* This will define all the `__W*' macros.  */
77 #include <waitstatus.h>
78
79 #define WEXITSTATUS(status)     __WEXITSTATUS(__WAIT_INT(status))
80 #define WTERMSIG(status)        __WTERMSIG(__WAIT_INT(status))
81 #define WSTOPSIG(status)        __WSTOPSIG(__WAIT_INT(status))
82 #define WIFEXITED(status)       __WIFEXITED(__WAIT_INT(status))
83 #define WIFSIGNALED(status)     __WIFSIGNALED(__WAIT_INT(status))
84 #define WIFSTOPPED(status)      __WIFSTOPPED(__WAIT_INT(status))
85
86 #ifdef  __USE_BSD
87 #define WCOREFLAG               __WCOREFLAG
88 #define WCOREDUMP(status)       __WCOREDUMP(__WAIT_INT(status))
89 #define W_EXITCODE(ret, sig)    __W_EXITCODE(ret, sig)
90 #define W_STOPCODE(sig)         __W_STOPCODE(sig)
91 #endif
92
93
94 /* Wait for a child to die.  When one does, put its status in *STAT_LOC
95    and return its process ID.  For errors, return (pid_t) -1.  */
96 extern __pid_t __wait __P ((__WAIT_STATUS __stat_loc));
97 extern __pid_t wait __P ((__WAIT_STATUS __stat_loc));
98
99 #ifdef  __USE_BSD
100 /* Special values for the PID argument to `waitpid' and `wait4'.  */
101 #define WAIT_ANY        (-1)    /* Any process.  */
102 #define WAIT_MYPGRP     0       /* Any process in my process group.  */
103 #endif
104
105 /* Wait for a child matching PID to die.
106    If PID is greater than 0, match any process whose process ID is PID.
107    If PID is (pid_t) -1, match any process.
108    If PID is (pid_t) 0, match any process with the
109    same process group as the current process.
110    If PID is less than -1, match any process whose
111    process group is the absolute value of PID.
112    If the WNOHANG bit is set in OPTIONS, and that child
113    is not already dead, return (pid_t) 0.  If successful,
114    return PID and store the dead child's status in STAT_LOC.
115    Return (pid_t) -1 for errors.  If the WUNTRACED bit is
116    set in OPTIONS, return status for stopped children; otherwise don't.  */
117 extern __pid_t __waitpid __P ((__pid_t __pid, int *__stat_loc,
118                                int __options));
119 extern __pid_t waitpid __P ((__pid_t __pid, int *__stat_loc,
120                              int __options));
121 #ifdef  __USE_BSD
122 /* This being here makes the prototypes valid whether or not
123    we have already included <sys/resource.h> to define `struct rusage'.  */
124 struct rusage;
125
126 /* Wait for a child to exit.  When one does, put its status in *STAT_LOC and
127    return its process ID.  For errors return (pid_t) -1.  If USAGE is not
128    nil, store information about the child's resource usage there.  If the
129    WUNTRACED bit is set in OPTIONS, return status for stopped children;
130    otherwise don't.  */
131 extern __pid_t __wait3 __P ((__WAIT_STATUS __stat_loc,
132                              int __options, struct rusage * __usage));
133 extern __pid_t wait3 __P ((__WAIT_STATUS __stat_loc,
134                            int __options, struct rusage * __usage));
135
136 /* PID is like waitpid.  Other args are like wait3.  */
137 extern __pid_t __wait4 __P ((__pid_t __pid, __WAIT_STATUS __stat_loc,
138                              int __options, struct rusage *__usage));
139 extern __pid_t wait4 __P ((__pid_t __pid, __WAIT_STATUS __stat_loc,
140                            int __options, struct rusage *__usage));
141 #endif /* Use BSD.  */
142
143
144 __END_DECLS
145
146 #endif /* sys/wait.h  */