share/man/man2/waitid.2

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.  Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH WAITID 2 "Jun 9, 2004"
  11 .SH NAME
  12 waitid \- wait for child process to change state
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <wait.h>
  17
  18 \fBint\fR \fBwaitid\fR(\fBidtype_t\fR \fIidtype\fR, \fBid_t\fR \fIid\fR, \fBsiginfo_t *\fR\fIinfop\fR, \fBint\fR \fIoptions\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBwaitid()\fR function suspends the calling process until one of its child
  25 processes changes state. It records the current state of a child in the
  26 structure pointed to by \fIinfop\fR. It returns immediately if a child process
  27 changed state prior to the call.
  28 .sp
  29 .LP
  30 The \fIidtype\fR and  \fIid\fR arguments specify which children  \fBwaitid()\fR
  31 is to wait for, as follows:
  32 .RS +4
  33 .TP
  34 .ie t \(bu
  35 .el o
  36 If  \fIidtype\fR is \fBP_PID\fR, \fBwaitid()\fR waits for the child with a
  37 process \fBID\fR equal to \fB(pid_t)\fR\fIid\fR.
  38 .RE
  39 .RS +4
  40 .TP
  41 .ie t \(bu
  42 .el o
  43 If \fIidtype\fR is \fBP_PGID\fR,  \fBwaitid()\fR waits for any child with a
  44 process group \fBID\fR equal to \fB(pid_t)\fR\fIid\fR.
  45 .RE
  46 .RS +4
  47 .TP
  48 .ie t \(bu
  49 .el o
  50 If \fIidtype\fR is \fBP_ALL\fR, \fBwaitid()\fR waits for any child and \fIid\fR
  51 is ignored.
  52 .RE
  53 .sp
  54 .LP
  55 The \fIoptions\fR argument is used to specify which state changes
  56 \fBwaitid()\fR is to wait for. It is formed by bitwise \fBOR\fR operation of
  57 any of the following flags:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBWCONTINUED\fR\fR
  62 .ad
  63 .RS 14n
  64 Return the status for any child that was stopped and has been continued.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBWEXITED\fR\fR
  71 .ad
  72 .RS 14n
  73 Wait for process(es) to exit.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBWNOHANG\fR\fR
  80 .ad
  81 .RS 14n
  82 Return immediately.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBWNOWAIT\fR\fR
  89 .ad
  90 .RS 14n
  91 Keep the process in a waitable state.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBWSTOPPED\fR\fR
  98 .ad
  99 .RS 14n
 100 Wait for and return the process status of any child that has  stopped upon
 101 receipt of a signal.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBWTRAPPED\fR\fR
 108 .ad
 109 .RS 14n
 110 Wait for traced process(es) to become trapped or reach a breakpoint (see
 111 \fBptrace\fR(3C)).
 112 .RE
 113
 114 .sp
 115 .LP
 116 The \fIinfop\fR argument must point to a \fBsiginfo_t\fR structure, as defined
 117 in \fBsiginfo.h\fR(3HEAD). If \fBwaitid()\fR returns because a child process
 118 was found that satisfies the conditions indicated by the arguments \fIidtype\fR
 119 and \fIoptions\fR, then the structure pointed to by \fIinfop\fR will be filled
 120 by the system with the status of the process. The \fBsi_signo\fR member will
 121 always be equal to \fBSIGCHLD\fR.
 122 .sp
 123 .LP
 124 One instance of a \fBSIGCHLD\fR signal is queued for each child process whose
 125 status has changed. If \fBwaitid()\fR returns because the status of a child
 126 process is available and \fBWNOWAIT\fR was not specified in \fIoptions\fR, any
 127 pending \fBSIGCHLD\fR signal associated with the process ID of that child
 128 process is discarded. Any other pending \fBSIGCHLD\fR signals remain pending.
 129 .SH RETURN VALUES
 130 .sp
 131 .LP
 132 If \fBwaitid()\fR returns due to a change of state of one of its children and
 133 \fBWNOHANG\fR was not used,  \fB0\fR is returned.  Otherwise, \fB\(mi1\fR is
 134 returned and  \fBerrno\fR is set to indicate the error. If \fBWNOHANG\fR was
 135 used,  \fB0\fR can be returned (indicating no error); however, no children may
 136 have changed state if \fBinfo->si_pid\fR is \fB0\fR.
 137 .SH ERRORS
 138 .sp
 139 .LP
 140 The \fBwaitid()\fR function will fail if:
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBECHILD\fR\fR
 145 .ad
 146 .RS 10n
 147 The set of processes specified by \fIidtype\fR and \fIid\fR does not contain
 148 any unwaited processes.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBEFAULT\fR\fR
 155 .ad
 156 .RS 10n
 157 The \fIinfop\fR argument points to an illegal address.
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fBEINTR\fR\fR
 164 .ad
 165 .RS 10n
 166 The \fBwaitid()\fR function was interrupted due to the receipt of a signal by
 167 the calling process.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBEINVAL\fR\fR
 174 .ad
 175 .RS 10n
 176 An invalid value was specified for \fIoptions\fR, or \fIidtype\fR and \fIid\fR
 177 specify an invalid set of processes.
 178 .RE
 179
 180 .SH USAGE
 181 .sp
 182 .LP
 183 With \fIoptions\fR equal to \fBWEXITED\fR | \fBWTRAPPED\fR, \fBwaitid()\fR is
 184 equivalent to \fBwaitpid\fR(3C). With \fIidtype\fR equal to \fBP_ALL\fR and
 185 \fIoptions\fR equal to \fBWEXITED\fR | \fBWTRAPPED\fR, \fBwaitid()\fR is
 186 equivalent to \fBwait\fR(3C).
 187 .SH ATTRIBUTES
 188 .sp
 189 .LP
 190 See \fBattributes\fR(5) for descriptions of the following attributes:
 191 .sp
 192
 193 .sp
 194 .TS
 195 box;
 196 c | c
 197 l | l .
 198 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 199 _
 200 Interface Stability     Standard
 201 _
 202 MT-Level        Async-Signal-Safe
 203 .TE
 204
 205 .SH SEE ALSO
 206 .sp
 207 .LP
 208 \fBIntro\fR(2), \fBexec\fR(2), \fBexit\fR(2), \fBfork\fR(2), \fBpause\fR(2),
 209 \fBsigaction\fR(2), \fBptrace\fR(3C), \fBsignal\fR(3C), \fBsiginfo.h\fR(3HEAD),
 210 \fBwait\fR(3C), \fBwaitpid\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)