xnu-6153.61.1.tar.gz

[apple/xnu.git] / bsd / sys / wait.h

diff --git a/bsd/sys/wait.h b/bsd/sys/wait.h
index 76bf41a3b9e619b61cf71f5be2295215fc79e2c2..498749fba9f0dd527efd845b8fa82a6c9f6f0e60 100644 (file)
--- a/bsd/sys/wait.h
+++ b/bsd/sys/wait.h
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
  *
 /*
  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
  *

- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*


@@ -54,9 +60,12 @@
  *
  *     @(#)wait.h      8.2 (Berkeley) 7/10/94
  */
  *
  *     @(#)wait.h      8.2 (Berkeley) 7/10/94
  */

- 
+

 #ifndef _SYS_WAIT_H_
 #ifndef _SYS_WAIT_H_

-#define        _SYS_WAIT_H_
+#define _SYS_WAIT_H_
+
+#include <sys/cdefs.h>
+#include <sys/_types.h>

 
 /*
  * This file holds definitions relevent to the wait4 system call
 
 /*
  * This file holds definitions relevent to the wait4 system call


@@ -64,31 +73,41 @@
  */
 
 /*
  */
 
 /*

- * Macros to test the exit status returned by wait
- * and extract the relevant values.
+ * [XSI] The type idtype_t shall be defined as an enumeration type whose
+ * possible values shall include at least P_ALL, P_PID, and P_PGID.

  */
  */

-#ifdef _POSIX_SOURCE
-#define        _W_INT(i)       (i)
-#else
-#define        _W_INT(w)       (*(int *)&(w))  /* convert union wait to int */
-#define        WCOREFLAG       0200
-
-#endif /* _POSIX_SOURCE */
-
-#define        _WSTATUS(x)     (_W_INT(x) & 0177)
-#define        _WSTOPPED       0177            /* _WSTATUS if process is stopped */
-#define WIFSTOPPED(x)  (_WSTATUS(x) == _WSTOPPED)
-#define WSTOPSIG(x)    (_W_INT(x) >> 8)
-#define WIFSIGNALED(x) (_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
-#define WTERMSIG(x)    (_WSTATUS(x))
-#define WIFEXITED(x)   (_WSTATUS(x) == 0)
-#define WEXITSTATUS(x) (_W_INT(x) >> 8)
-#if !defined(_POSIX_SOURCE)
-#define WCOREDUMP(x)   (_W_INT(x) & WCOREFLAG)
-
-#define        W_EXITCODE(ret, sig)    ((ret) << 8 | (sig))
-#define        W_STOPCODE(sig)         ((sig) << 8 | _WSTOPPED)
-#endif /* !defined(_POSIX_SOURCE) */
+typedef enum {
+       P_ALL,
+       P_PID,
+       P_PGID
+} idtype_t;
+
+/*
+ * [XSI] The id_t and pid_t types shall be defined as described
+ * in <sys/types.h>
+ */
+#include <sys/_types/_pid_t.h>
+#include <sys/_types/_id_t.h>
+
+/*
+ * [XSI] The siginfo_t type shall be defined as described in <signal.h>
+ * [XSI] The rusage structure shall be defined as described in <sys/resource.h>
+ * [XSI] Inclusion of the <sys/wait.h> header may also make visible all
+ * symbols from <signal.h> and <sys/resource.h>
+ *
+ * NOTE:       This requirement is currently being satisfied by the direct
+ *             inclusion of <sys/signal.h> and <sys/resource.h>, below.
+ *
+ *             Software should not depend on the exposure of anything other
+ *             than the types siginfo_t and struct rusage as a result of
+ *             this inclusion.  If you depend on any types or manifest
+ *             values othe than siginfo_t and struct rusage from either of
+ *             those files, you should explicitly include them yourself, as
+ *             well, or in future releases your stware may not compile
+ *             without modification.
+ */
+#include <sys/signal.h>         /* [XSI] for siginfo_t */
+#include <sys/resource.h>       /* [XSI] for struct rusage */

 
 /*
  * Option bits for the third argument of wait4.  WNOHANG causes the
 
 /*
  * Option bits for the third argument of wait4.  WNOHANG causes the


@@ -99,43 +118,96 @@
  * this option is done, it is as though they were still running... nothing
  * about them is returned.
  */
  * this option is done, it is as though they were still running... nothing
  * about them is returned.
  */

-#define WNOHANG                1       /* don't hang in wait */
-#define WUNTRACED      2       /* tell about stopped, untraced children */
+#define WNOHANG         0x00000001  /* [XSI] no hang in wait/no child to reap */
+#define WUNTRACED       0x00000002  /* [XSI] notify on stop, untraced child */

 
 

-#if !defined(_POSIX_SOURCE)
+/*
+ * Macros to test the exit status returned by wait
+ * and extract the relevant values.
+ */
+#if defined(_POSIX_C_SOURCE) && !defined(_DARWIN_C_SOURCE)
+#define _W_INT(i)       (i)
+#else
+#define _W_INT(w)       (*(int *)&(w))  /* convert union wait to int */
+#define WCOREFLAG       0200
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
+
+/* These macros are permited, as they are in the implementation namespace */
+#define _WSTATUS(x)     (_W_INT(x) & 0177)
+#define _WSTOPPED       0177            /* _WSTATUS if process is stopped */
+
+/*
+ * [XSI] The <sys/wait.h> header shall define the following macros for
+ * analysis of process status values
+ */
+#if __DARWIN_UNIX03
+#define WEXITSTATUS(x)  ((_W_INT(x) >> 8) & 0x000000ff)
+#else /* !__DARWIN_UNIX03 */
+#define WEXITSTATUS(x)  (_W_INT(x) >> 8)
+#endif /* !__DARWIN_UNIX03 */
+/* 0x13 == SIGCONT */
+#define WSTOPSIG(x)     (_W_INT(x) >> 8)
+#define WIFCONTINUED(x) (_WSTATUS(x) == _WSTOPPED && WSTOPSIG(x) == 0x13)
+#define WIFSTOPPED(x)   (_WSTATUS(x) == _WSTOPPED && WSTOPSIG(x) != 0x13)
+#define WIFEXITED(x)    (_WSTATUS(x) == 0)
+#define WIFSIGNALED(x)  (_WSTATUS(x) != _WSTOPPED && _WSTATUS(x) != 0)
+#define WTERMSIG(x)     (_WSTATUS(x))
+#if (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
+#define WCOREDUMP(x)    (_W_INT(x) & WCOREFLAG)
+
+#define W_EXITCODE(ret, sig)    ((ret) << 8 | (sig))
+#define W_STOPCODE(sig)         ((sig) << 8 | _WSTOPPED)
+#endif /* (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)) */
+
+/*
+ * [XSI] The following symbolic constants shall be defined as possible
+ * values for the fourth argument to waitid().
+ */
+/* WNOHANG already defined for wait4() */
+/* WUNTRACED defined for wait4() but not for waitid() */
+#define WEXITED         0x00000004  /* [XSI] Processes which have exitted */
+#if __DARWIN_UNIX03
+/* waitid() parameter */
+#define WSTOPPED        0x00000008  /* [XSI] Any child stopped by signal */
+#endif
+#define WCONTINUED      0x00000010  /* [XSI] Any child stopped then continued */
+#define WNOWAIT         0x00000020  /* [XSI] Leave process returned waitable */
+
+
+#if (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))

 /* POSIX extensions and 4.2/4.3 compatability: */
 
 /*
  * Tokens for special values of the "pid" parameter to wait4.
  */
 /* POSIX extensions and 4.2/4.3 compatability: */
 
 /*
  * Tokens for special values of the "pid" parameter to wait4.
  */

-#define        WAIT_ANY        (-1)    /* any process */
-#define        WAIT_MYPGRP     0       /* any process in my process group */
+#define WAIT_ANY        (-1)    /* any process */
+#define WAIT_MYPGRP     0       /* any process in my process group */

 
 #include <machine/endian.h>
 
 /*
  * Deprecated:
  * Structure of the information in the status word returned by wait4.
 
 #include <machine/endian.h>
 
 /*
  * Deprecated:
  * Structure of the information in the status word returned by wait4.

- * If w_stopval==WSTOPPED, then the second structure describes
+ * If w_stopval==_WSTOPPED, then the second structure describes

  * the information returned, else the first.
  */
 union wait {
  * the information returned, else the first.
  */
 union wait {

-       int     w_status;               /* used in syscall */
+       int     w_status;               /* used in syscall */

        /*
         * Terminated process status.
         */
        struct {
        /*
         * Terminated process status.
         */
        struct {

-#if BYTE_ORDER == LITTLE_ENDIAN 
-               unsigned int    w_Termsig:7,    /* termination signal */
-                               w_Coredump:1,   /* core dump indicator */
-                               w_Retcode:8,    /* exit code if w_termsig==0 */
-                               w_Filler:16;    /* upper bits filler */
+#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
+               unsigned int    w_Termsig:7,    /* termination signal */
+                   w_Coredump:1,               /* core dump indicator */
+                   w_Retcode:8,                /* exit code if w_termsig==0 */
+                   w_Filler:16;                /* upper bits filler */

 #endif
 #endif

-#if BYTE_ORDER == BIG_ENDIAN 
-               unsigned int    w_Filler:16,    /* upper bits filler */
-                               w_Retcode:8,    /* exit code if w_termsig==0 */
-                               w_Coredump:1,   /* core dump indicator */
-                               w_Termsig:7;    /* termination signal */
+#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
+               unsigned int    w_Filler:16,    /* upper bits filler */
+                   w_Retcode:8,                /* exit code if w_termsig==0 */
+                   w_Coredump:1,               /* core dump indicator */
+                   w_Termsig:7;                /* termination signal */

 #endif
        } w_T;
        /*
 #endif
        } w_T;
        /*


@@ -144,40 +216,45 @@ union wait {
         * with the WUNTRACED option bit.
         */
        struct {
         * with the WUNTRACED option bit.
         */
        struct {

-#if BYTE_ORDER == LITTLE_ENDIAN 
-               unsigned int    w_Stopval:8,    /* == W_STOPPED if stopped */
-                               w_Stopsig:8,    /* signal that stopped us */
-                               w_Filler:16;    /* upper bits filler */
+#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
+               unsigned int    w_Stopval:8,    /* == W_STOPPED if stopped */
+                   w_Stopsig:8,                /* signal that stopped us */
+                   w_Filler:16;                /* upper bits filler */

 #endif
 #endif

-#if BYTE_ORDER == BIG_ENDIAN 
-               unsigned int    w_Filler:16,    /* upper bits filler */
-                               w_Stopsig:8,    /* signal that stopped us */
-                               w_Stopval:8;    /* == W_STOPPED if stopped */
+#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
+               unsigned int    w_Filler:16,    /* upper bits filler */
+                   w_Stopsig:8,                /* signal that stopped us */
+                   w_Stopval:8;                /* == W_STOPPED if stopped */

 #endif
        } w_S;
 };
 #endif
        } w_S;
 };

-#define        w_termsig       w_T.w_Termsig
-#define w_coredump     w_T.w_Coredump
-#define w_retcode      w_T.w_Retcode
-#define w_stopval      w_S.w_Stopval
-#define w_stopsig      w_S.w_Stopsig
+#define w_termsig       w_T.w_Termsig
+#define w_coredump      w_T.w_Coredump
+#define w_retcode       w_T.w_Retcode
+#define w_stopval       w_S.w_Stopval
+#define w_stopsig       w_S.w_Stopsig

 
 

-#define        WSTOPPED        _WSTOPPED
-#endif /* !defined(_POSIX_SOURCE) */
+#endif /* (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)) */

 
 

-#ifndef KERNEL
-#include <sys/types.h>
-#include <sys/cdefs.h>
+#if !(__DARWIN_UNIX03 - 0)
+/*
+ * Stopped state value; cannot use waitid() parameter of the same name
+ * in the same scope
+ */
+#define WSTOPPED        _WSTOPPED
+#endif /* !__DARWIN_UNIX03 */

 
 

+#ifndef KERNEL

 __BEGIN_DECLS
 __BEGIN_DECLS

-struct rusage; /* forward declaration */
-
-pid_t  wait __P((int *));
-pid_t  waitpid __P((pid_t, int *, int));
-#if  !defined(_POSIX_SOURCE)
-pid_t  wait3 __P((int *, int, struct rusage *));
-pid_t  wait4 __P((pid_t, int *, int, struct rusage *));
-#endif /* !defined(_POSIX_SOURCE) */
+pid_t   wait(int *) __DARWIN_ALIAS_C(wait);
+pid_t   waitpid(pid_t, int *, int) __DARWIN_ALIAS_C(waitpid);
+#ifndef _ANSI_SOURCE
+int     waitid(idtype_t, id_t, siginfo_t *, int) __DARWIN_ALIAS_C(waitid);
+#endif /* !_ANSI_SOURCE */
+#if  (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
+pid_t   wait3(int *, int, struct rusage *);
+pid_t   wait4(pid_t, int *, int, struct rusage *);
+#endif /* (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)) */

 __END_DECLS
 #endif
 #endif /* !_SYS_WAIT_H_ */
 __END_DECLS
 #endif
 #endif /* !_SYS_WAIT_H_ */