Initial revision
[kopensolaris-gnu/glibc.git] / posix / sys / wait.h
1 /* Copyright (C) 1991 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 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 #include <gnu/types.h>
29 #include <gnu/wait.h>
30
31
32 #define WNOHANG         __WNOHANG
33 #define WUNTRACED       __WUNTRACED
34
35
36 /* Encoding of the status word.  */
37
38 #ifdef  __USE_BSD
39 union __wait
40   {
41 #ifdef  __LITTLE_ENDIAN
42     struct
43       {
44         unsigned int __w_termsig:7;
45         unsigned int __w_coredump:1;
46         unsigned int __w_retcode:8;
47         unsigned int :16;
48       } __wait_status;
49 #else   /* Big endian.  */
50     struct
51       {
52         unsigned int :16;
53         unsigned int __w_retcode:8;
54         unsigned int __w_coredump:1;
55         unsigned int __w_termsig:7;
56       } __wait_status;
57 #endif  /* Little endian.  */
58   };
59 #define w_termsig       __wait_status.__w_termsig
60 #define w_coredump      __wait_status.__w_coredump
61 #define w_retcode       __wait_status.__w_retcode
62 #define w_stopsig       w_retcode
63
64 #ifdef  __GNUC__
65 #define __WAIT_INT(status)                                                    \
66   (__extension__ ({ union { __typeof(status) __in; int __i; } __u;            \
67                     __u.__in = (status); __u.__i; }))
68 #else
69 #define __WAIT_INT(status)      (*(int *) &(status))
70 #endif
71
72 /* This is the type of the argument to `wait'.
73    With GCC v2, this will be a strange union.  */
74
75 /* IGNORE(@This line MUST be split!  m4 will not change it otherwise.@)  */
76 #define __WAIT_STATUS   \
77   PTR
78
79 #else   /* Don't use BSD.  */
80
81 #define __WAIT_INT(status)      (status)
82
83 #define __WAIT_STATUS   int *
84
85 #endif  /* Use BSD.  */
86
87 #define WEXITSTATUS(status)     __WEXITSTATUS(__WAIT_INT(status))
88 #define WTERMSIG(status)        __WTERMSIG(__WAIT_INT(status))
89 #define WSTOPSIG(status)        __WSTOPSIG(__WAIT_INT(status))
90 #define WIFEXITED(status)       __WIFEXITED(__WAIT_INT(status))
91 #define WIFSIGNALED(status)     __WIFSIGNALED(__WAIT_INT(status))
92 #define WIFSTOPPED(status)      __WIFSTOPPED(__WAIT_INT(status))
93
94 #ifdef  __USE_BSD
95 #define WCOREDUMP(status)       __WCOREDUMP(__WAIT_INT(status))
96 #endif
97
98
99 /* Wait for a child to die.  When one does, put its status in *STAT_LOC
100    and return its process ID.  For errors, return (pid_t) -1.  */
101 extern __pid_t EXFUN(__wait, (__WAIT_STATUS __stat_loc));
102 extern __pid_t EXFUN(wait, (__WAIT_STATUS __stat_loc));
103
104 #ifdef  __USE_BSD
105 /* Special values for the PID argument to `waitpid' and `wait4'.  */
106 #define WAIT_ANY        (-1)    /* Any process.  */
107 #define WAIT_MYPGRP     0       /* Any process in my process group.  */
108 #endif
109
110 /* Wait for a child matching PID to die.
111    If PID is greater than 0, match any process whose process ID is PID.
112    If PID is (pid_t) -1, match any process.
113    If PID is (pid_t) 0, match any process with the
114    same process group as the current process.
115    If PID is less than -1, match any process whose
116    process group is the absolute value of PID.
117    If the WNOHANG bit is set in OPTIONS, and that child
118    is not already dead, return (pid_t) 0.  If successful,
119    return PID and store the dead child's status in STAT_LOC.
120    Return (pid_t) -1 for errors.  If the WUNTRACED bit is
121    set in OPTIONS, return status for stopped children; otherwise don't.  */
122 extern __pid_t EXFUN(__waitpid, (__pid_t __pid, int *__stat_loc,
123                                  int __options));
124 #ifdef  __USE_BSD
125 /* Wait for a child to exit.  When one does, put its status in *STAT_LOC and
126    return its process ID.  For errors return (pid_t) -1.  If USAGE is not nil,
127    store information about the child's resource usage (as a `struct rusage')
128    there.  If the WUNTRACED bit is set in OPTIONS, return status for stopped
129    children; otherwise don't.  */
130 extern __pid_t EXFUN(__wait3, (union __wait *__stat_loc,
131                                int __options, PTR __usage));
132 #define wait3   __wait3
133
134 /* PID is like waitpid.  Other args are like wait3.  */
135 extern __pid_t EXFUN(__wait4, (__pid_t __pid, union __wait *__stat_loc,
136                                int __options, PTR __usage));
137 #define wait4   __wait4
138 #endif  /* Use BSD.  */
139
140 #define waitpid __waitpid
141 #define wait    __wait
142
143
144 #endif  /* sys/wait.h  */