posix/sys/wait.h

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