WAIT(2) BSD System Calls Manual WAIT(2)

NAME
     wwaaiitt, wwaaiitt33, wwaaiitt44, wwaaiittppiidd - wait for process termination

SYNOPSIS
     ##iinncclluuddee <>

     pidt
     wwaaiitt(int *statloc);

     pidt
     wwaaiitt33(int *statloc, int options, struct rusage *rusage);

     pidt
     wwaaiitt44(pidt pid, int *statloc, int options, struct rusage *rusage);

     pidt
     wwaaiittppiidd(pidt pid, int *statloc, int options);

DESCRIPTION
     The wwaaiitt() function suspends execution of its calling process until
     statloc information is available for a terminated child process, or a
     signal is received.  On return from a successful wwaaiitt() call, the
     statloc area contains termination information about the process that
     exited as defined below.

     The wwaaiitt44() call provides a more general interface for programs that need
     to wait for certain child processes, that need resource utilization sta-
     tistics accumulated by child processes, or that require options.  The
     other wait functions are implemented using wwaaiitt44().

     The pid parameter specifies the set of child processes for which to wait.
     If pid is -1, the call waits for any child process.  If pid is 0, the
     call waits for any child process in the process group of the caller.  If
     pid is greater than zero, the call waits for the process with process id
     pid.  If pid is less than -1, the call waits for any process whose
     process group id equals the absolute value of pid.

     The statloc parameter is defined below.  The options parameter contains
     the bitwise OR of any of the following options.  The WNOHANG option is
     used to indicate that the call should not block if there are no processes
     that wish to report status.  If the WUNTRACED option is set, children of
     the current process that are stopped due to a SIGTTIN, SIGTTOU, SIGTSTP,
     or SIGSTOP signal also have their status reported.

     If rusage is non-zero, a summary of the resources used by the terminated
     process and all its children is returned (this information is currently
     not available for stopped processes).

     When the WNOHANG option is specified and no processes wish to report sta-
     tus, wwaaiitt44() returns a process id of 0.

     The wwaaiittppiidd() call is identical to wwaaiitt44() with an rusage value of zero.
     The older wwaaiitt33() call is the same as wwaaiitt44() with a pid value of -1.

     The following macros may be used to test the manner of exit of the
     process.  One of the first three macros will evaluate to a non-zero
     (true) value:

     WWIIFFEEXXIITTEEDD(status)
             True if the process terminated normally by a call to exit(2) or
             exit(3).

     WWIIFFSSIIGGNNAALLEEDD(status)
             True if the process terminated due to receipt of a signal.

     WWIIFFSSTTOOPPPPEEDD(status)
             True if the process has not terminated, but has stopped and can
             be restarted.  This macro can be true only if the wait call spec-
             ified the WUNTRACED option or if the child process is being
             traced (see ptrace(2)).

     Depending on the values of those macros, the following macros produce the
     remaining status information about the child process:

     WWEEXXIITTSSTTAATTUUSS(status)
             If WWIIFFEEXXIITTEEDD(status) is true, evaluates to the low-order 8 bits
             of the argument passed to exit(2) or exit(3) by the child.

     WWTTEERRMMSSIIGG(status)
             If WWIIFFSSIIGGNNAALLEEDD(status) is true, evaluates to the number of the
             signal that caused the termination of the process.

     WWCCOORREEDDUUMMPP(status)
             If WWIIFFSSIIGGNNAALLEEDD(status) is true, evaluates as true if the termina-
             tion of the process was accompanied by the creation of a core
             file containing an image of the process when the signal was
             received.

     WWSSTTOOPPSSIIGG(status)
             If WWIIFFSSTTOOPPPPEEDD(status) is true, evaluates to the number of the
             signal that caused the process to stop.

NNOOTTEESS
     See sigaction(2) for a list of termination signals.  A status of 0 indi-
     cates normal termination.

     If a parent process terminates without waiting for all of its child pro-
     cesses to terminate, the remaining child processes are assigned the par-
     ent process 1 ID (the init process ID).

     If a signal is caught while any of the wwaaiitt() calls is pending, the call
     may be interrupted or restarted when the signal-catching routine returns,
     depending on the options in effect for the signal; see intro(2), System
     call restart.

RETURN VALUES
     If wwaaiitt() returns due to a stopped or terminated child process, the
     process ID of the child is returned to the calling process.  Otherwise, a
     value of -1 is returned and errno is set to indicate the error.

     If wwaaiitt33(), wwaaiitt44(), or wwaaiittppiidd() returns due to a stopped or terminated
     child process, the process ID of the child is returned to the calling
     process.  If there are no children not previously awaited, -1 is returned
     with errno set to [ECHILD].  Otherwise, if WNOHANG is specified and there
     are no stopped or exited children, 0 is returned.  If an error is
     detected or a caught signal aborts the call, a value of -1 is returned
     and errno is set to indicate the error.

EERRRROORRSS
     The wwaaiitt() system call will fail and return immediately if:

     [ECHILD]           The calling process has no existing unwaited-for child
                        processes.

     [EFAULT]           The status or rusage argument points to an illegal
                        address (may not be detected before the exit of a
                        child process).

     [EINVAL]           Invalid or undefined flags are passed in the options
                        argument.

     The wwaaiitt33() and wwaaiittppiidd() calls will fail and return immediately if:

     [ECHILD]           The process specified by pid does not exist or is not
                        a child of the calling process, or the process group
                        specified by pid does not exist or does not have any
                        member process that is a child of the calling process.

     The wwaaiittppiidd() call will fail and return immediately if:

     [EINVAL]           The options argument is not valid.

     Any of these calls will fail and return immediately if:

     [EINTR]            The call is interrupted by a caught signal or the sig-
                        nal does not have the SARESTART flag set.

STANDARDS     The wwaaiitt() and wwaaiittppiidd() functions are defined by POSIX; wwaaiitt33() and
     wwaaiitt44() are not specified by POSIX.  The WWCCOORREEDDUUMMPP() macro and the abil-
     ity to restart a pending wwaaiitt() call are extensions to the POSIX inter-
     face.

LEGACY SYNOPSIS
     ##iinncclluuddee <>
     ##iinncclluuddee <>

     The include file  is necessary.

SEE ALSO
     sigaction(2), exit(3), compat(5)

HISTORY     A wwaaiitt() function call appeared in Version 6 AT&T UNIX.

4th Berkeley Distribution       April 19, 1994       4th Berkeley Distribution