wait(2POSIX)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | PARAMETERS | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO | NOTES

NAME

wait, waitpid- wait for process termination

SYNOPSIS

#include <sys/types.h>
#include <sys/wait.h>

pid_t wait(int * status);


#include <sys/time.h>
#include <sys/resource.h>

pid_t waitpid(pid_t wpid, int * status, int options);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

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

waitpid() provides a more general interface for programs that need to wait for certain child processes, that need resource utilization statistics accumulated by child processes, or that require options.

PARAMETERS

wait() supports the following parameter:

status

Contains termination information about the process that exited as defined below.

waitpid() supports the following parameters:

wpid

Specifies the set of child processes for which to wait.

If wpid is -1 , the call waits for any child process. If wpid is 0 , the call waits for any child process in the process group of the caller. If wpid is greater than zero, the call waits for the process with process id wpid . If wpid is less than -1 , the call waits for any process whose process group id equals the absolute value of wpid .

status

Contains termination information about the process that exited as defined below.

options

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.

When the WNOHANG option is specified and no processes wish to report status, waitpid() returns a process id of 0 .

Status

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:

WIFEXITED(status)

True if the process terminated normally by a call to _exit(2K) or exit(3STDC) .

WIFSIGNALED(status)

True if the process terminated due to receipt of a signal.

WIFSTOPPED(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 specified the WUNTRACED option or if the child process is being traced.

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

WEXITSTATUS(status)

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

WTERMSIG(status)

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

WCOREDUMP(status)

If WIFSIGNALED(status) is true, evaluates as true if the termination of the process was accompanied by the creation of a core file containing an image of the process when the signal was received.

WSTOPSIG(status)

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

RETURN VALUES

If wait() 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 waitpid() 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.

ERRORS

wait() will fail and return immediately if:

ECHILD

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

EFAULT

The status arguments point to an illegal address. (May not be detected before exit of a child process.)

EINTR

The call was interrupted by a caught signal, or the signal did not have the SA_RESTART flag set.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving
MT-Level	Async-Signal-Safe

SEE ALSO

_exit(2K) , sigaction(2POSIX) , exit(3STDC)

NOTES

See sigaction(2POSIX) for a list of termination signals. A status of 0 indicates normal termination.

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

If a signal is caught while a wait() or waitpid() call is pending, the call may be interrupted or restarted when the signal-catching routine returns, depending on the options in effect for the signal.

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | PARAMETERS | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO | NOTES