bsd/sys/wait.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  31 /*
  32  * Copyright (c) 1982, 1986, 1989, 1993, 1994
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)wait.h      8.2 (Berkeley) 7/10/94
  64  */
  65
  66 #ifndef _SYS_WAIT_H_
  67 #define _SYS_WAIT_H_
  68
  69 #include <sys/cdefs.h>
  70 #include <sys/_types.h>
  71
  72 /*
  73  * This file holds definitions relevent to the wait4 system call
  74  * and the alternate interfaces that use it (wait, wait3, waitpid).
  75  */
  76
  77 /*
  78  * [XSI] The type idtype_t shall be defined as an enumeration type whose
  79  * possible values shall include at least P_ALL, P_PID, and P_PGID.
  80  */
  81 typedef enum {
  82         P_ALL,
  83         P_PID,
  84         P_PGID
  85 } idtype_t;
  86
  87 /*
  88  * [XSI] The id_t and pid_t types shall be defined as described
  89  * in <sys/types.h>
  90  */
  91 #ifndef _PID_T
  92 typedef __darwin_pid_t  pid_t;
  93 #define _PID_T
  94 #endif
  95
  96 #ifndef _ID_T
  97 typedef __darwin_id_t   id_t;
  98 #define _ID_T
  99 #endif
 100
 101 /*
 102  * [XSI] The siginfo_t type shall be defined as described in <signal.h>
 103  * [XSI] The rusage structure shall be defined as described in <sys/resource.h>
 104  * [XSI] Inclusion of the <sys/wait.h> header may also make visible all
 105  * symbols from <signal.h> and <sys/resource.h>
 106  *
 107  * NOTE:        This requirement is currently being satisfied by the direct
 108  *              inclusion of <sys/signal.h> and <sys/resource.h>, below.
 109  *
 110  *              Software should not depend on the exposure of anything other
 111  *              than the types siginfo_t and struct rusage as a result of
 112  *              this inclusion.  If you depend on any types or manifest
 113  *              values othe than siginfo_t and struct rusage from either of
 114  *              those files, you should explicitly include them yourself, as
 115  *              well, or in future releases your stware may not compile
 116  *              without modification.
 117  */
 118 #include <sys/signal.h>         /* [XSI] for siginfo_t */
 119 #include <sys/resource.h>       /* [XSI] for struct rusage */
 120
 121 /*
 122  * Option bits for the third argument of wait4.  WNOHANG causes the
 123  * wait to not hang if there are no stopped or terminated processes, rather
 124  * returning an error indication in this case (pid==0).  WUNTRACED
 125  * indicates that the caller should receive status about untraced children
 126  * which stop due to signals.  If children are stopped and a wait without
 127  * this option is done, it is as though they were still running... nothing
 128  * about them is returned.
 129  */
 130 #define WNOHANG         0x01    /* [XSI] don't hang in wait/no child to reap */
 131 #define WUNTRACED       0x02    /* [XSI] notify on stopped, untraced children */
 132
 133 /*
 134  * Macros to test the exit status returned by wait
 135  * and extract the relevant values.
 136  */
 137 #ifdef _POSIX_C_SOURCE
 138 #define _W_INT(i)       (i)
 139 #else
 140 #define _W_INT(w)       (*(int *)&(w))  /* convert union wait to int */
 141 #define WCOREFLAG       0200
 142 #endif /* _POSIX_C_SOURCE */
 143
 144 /* These macros are permited, as they are in the implementation namespace */
 145 #define _WSTATUS(x)     (_W_INT(x) & 0177)
 146 #define _WSTOPPED       0177            /* _WSTATUS if process is stopped */
 147
 148 /*
 149  * [XSI] The <sys/wait.h> header shall define the following macros for
 150  * analysis of process status values
 151  */
 152 #define WEXITSTATUS(x)  (_W_INT(x) >> 8)
 153 #define WIFCONTINUED(x) (x == 0x13)     /* 0x13 == SIGCONT */
 154 #define WIFEXITED(x)    (_WSTATUS(x) == 0)
 155 #define WIFSIGNALED(x)  (_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
 156 #define WIFSTOPPED(x)   (_WSTATUS(x) == _WSTOPPED)
 157 #define WSTOPSIG(x)     (_W_INT(x) >> 8)
 158 #define WTERMSIG(x)     (_WSTATUS(x))
 159 #if !defined(_POSIX_C_SOURCE)
 160 #define WCOREDUMP(x)    (_W_INT(x) & WCOREFLAG)
 161
 162 #define W_EXITCODE(ret, sig)    ((ret) << 8 | (sig))
 163 #define W_STOPCODE(sig)         ((sig) << 8 | _WSTOPPED)
 164 #endif /* !defined(_POSIX_C_SOURCE) */
 165
 166 /*
 167  * [XSI] The following symbolic constants shall be defined as possible
 168  * values for the fourth argument to waitid().
 169  */
 170 /* WNOHANG already defined for wait4() */
 171 /* WUNTRACED defined for wait4() but not for waitid() */
 172 #define WEXITED         0x04    /* [XSI] Processes which have exitted */
 173 #ifdef _POSIX_C_SOURCE
 174 /* waitid() parameter */
 175 #define WSTOPPED        0x08    /* [XSI] Any child stopped by signal receipt */
 176 #endif
 177 #define WCONTINUED      0x10    /* [XSI] Any child stopped then continued */
 178 #define WNOWAIT         0x20    /* [XSI] Leave process returned waitable */
 179
 180
 181 #if !defined(_POSIX_C_SOURCE)
 182 /* POSIX extensions and 4.2/4.3 compatability: */
 183
 184 /*
 185  * Tokens for special values of the "pid" parameter to wait4.
 186  */
 187 #define WAIT_ANY        (-1)    /* any process */
 188 #define WAIT_MYPGRP     0       /* any process in my process group */
 189
 190 #include <machine/endian.h>
 191
 192 /*
 193  * Deprecated:
 194  * Structure of the information in the status word returned by wait4.
 195  * If w_stopval==WSTOPPED, then the second structure describes
 196  * the information returned, else the first.
 197  */
 198 union wait {
 199         int     w_status;               /* used in syscall */
 200         /*
 201          * Terminated process status.
 202          */
 203         struct {
 204 #if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
 205                 unsigned int    w_Termsig:7,    /* termination signal */
 206                                 w_Coredump:1,   /* core dump indicator */
 207                                 w_Retcode:8,    /* exit code if w_termsig==0 */
 208                                 w_Filler:16;    /* upper bits filler */
 209 #endif
 210 #if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
 211                 unsigned int    w_Filler:16,    /* upper bits filler */
 212                                 w_Retcode:8,    /* exit code if w_termsig==0 */
 213                                 w_Coredump:1,   /* core dump indicator */
 214                                 w_Termsig:7;    /* termination signal */
 215 #endif
 216         } w_T;
 217         /*
 218          * Stopped process status.  Returned
 219          * only for traced children unless requested
 220          * with the WUNTRACED option bit.
 221          */
 222         struct {
 223 #if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
 224                 unsigned int    w_Stopval:8,    /* == W_STOPPED if stopped */
 225                                 w_Stopsig:8,    /* signal that stopped us */
 226                                 w_Filler:16;    /* upper bits filler */
 227 #endif
 228 #if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
 229                 unsigned int    w_Filler:16,    /* upper bits filler */
 230                                 w_Stopsig:8,    /* signal that stopped us */
 231                                 w_Stopval:8;    /* == W_STOPPED if stopped */
 232 #endif
 233         } w_S;
 234 };
 235 #define w_termsig       w_T.w_Termsig
 236 #define w_coredump      w_T.w_Coredump
 237 #define w_retcode       w_T.w_Retcode
 238 #define w_stopval       w_S.w_Stopval
 239 #define w_stopsig       w_S.w_Stopsig
 240
 241 /*
 242  * Stopped state value; cannot use waitid() parameter of the same name
 243  * in the same scope
 244  */
 245 #define WSTOPPED        _WSTOPPED
 246 #endif /* !defined(_POSIX_C_SOURCE) */
 247
 248 #ifndef KERNEL
 249 __BEGIN_DECLS
 250 pid_t   wait(int *);
 251 pid_t   waitpid(pid_t, int *, int);
 252 #ifndef _ANSI_SOURCE
 253 int     waitid(idtype_t, id_t, siginfo_t *, int);
 254 #endif /* !_ANSI_SOURCE */
 255 #if  !defined(_POSIX_C_SOURCE)
 256 pid_t   wait3(int *, int, struct rusage *);
 257 pid_t   wait4(pid_t, int *, int, struct rusage *);
 258 #endif /* !defined(_POSIX_C_SOURCE) */
 259 __END_DECLS
 260 #endif
 261 #endif /* !_SYS_WAIT_H_ */