original/man2/wait.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 1993 by Thomas Koenig <ig25@rz.uni-karlsruhe.de>
   4 .\" and Copyright (c) 2004 by Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\"
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" License.
  26 .\"
  27 .\" Modified Sat Jul 24 13:30:06 1993 by Rik Faith <faith@cs.unc.edu>
  28 .\" Modified Sun Aug 21 17:42:42 1994 by Rik Faith <faith@cs.unc.edu>
  29 .\"          (Thanks to Koen Holtman <koen@win.tue.nl>)
  30 .\" Modified Wed May 17 15:54:12 1995 by Rik Faith <faith@cs.unc.edu>
  31 .\"           To remove *'s from status in macros (Thanks to Michael Shields).
  32 .\" Modified as suggested by Nick Duffek <nsd@bbc.com>, aeb, 960426
  33 .\" Modified Mon Jun 23 14:09:52 1997 by aeb - add EINTR.
  34 .\" Modified Thu Nov 26 02:12:45 1998 by aeb - add SIGCHLD stuff.
  35 .\" Modified Mon Jul 24 21:37:38 2000 by David A. Wheeler
  36 .\"          <dwheeler@dwheeler.com> - noted thread issues.
  37 .\" Modified 26 Jun 01 by Michael Kerrisk
  38 .\"          Added __WCLONE, __WALL, and __WNOTHREAD descriptions
  39 .\" Modified 2001-09-25, aeb
  40 .\" Modified 26 Jun 01 by Michael Kerrisk, <mtk.manpages@gmail.com>
  41 .\"     Updated notes on setting disposition of SIGCHLD to SIG_IGN
  42 .\" 2004-11-11, mtk
  43 .\"     Added waitid(2); added WCONTINUED and WIFCONTINUED()
  44 .\"     Added text on SA_NOCLDSTOP
  45 .\"     Updated discussion of SA_NOCLDWAIT to reflect 2.6 behavior
  46 .\"     Much other text rewritten
  47 .\" 2005-05-10, mtk, __W* flags can't be used with waitid()
  48 .\" 2008-07-04, mtk, removed erroneous text about SA_NOCLDSTOP
  49 .\"
  50 .TH WAIT 2 2010-09-26 "Linux" "Linux Programmer's Manual"
  51 .SH NAME
  52 wait, waitpid, waitid \- wait for process to change state
  53 .SH SYNOPSIS
  54 .B #include <sys/types.h>
  55 .br
  56 .B #include <sys/wait.h>
  57 .sp
  58 .BI "pid_t wait(int *" "status" );
  59
  60 .BI "pid_t waitpid(pid_t " pid ", int *" status ", int " options );
  61
  62 .BI "int waitid(idtype_t " idtype ", id_t " id \
  63 ", siginfo_t *" infop ", int " options );
  64 .sp
  65 .in -4n
  66 Feature Test Macro Requirements for glibc (see
  67 .BR feature_test_macros (7)):
  68 .in
  69 .sp
  70 .ad l
  71 .PD 0
  72 .BR waitid ():
  73 .RS 4
  74 _SVID_SOURCE ||
  75 _XOPEN_SOURCE\ >=\ 500 ||
  76 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  77 .br
  78 || /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
  79 .RE
  80 .PD
  81 .ad
  82 .SH DESCRIPTION
  83 All of these system calls are used to wait for state changes
  84 in a child of the calling process, and obtain information
  85 about the child whose state has changed.
  86 A state change is considered to be: the child terminated;
  87 the child was stopped by a signal; or the child was resumed by a signal.
  88 In the case of a terminated child, performing a wait allows
  89 the system to release the resources associated with the child;
  90 if a wait is not performed, then the terminated child remains in
  91 a "zombie" state (see NOTES below).
  92
  93 If a child has already changed state, then these calls return immediately.
  94 Otherwise they block until either a child changes state or
  95 a signal handler interrupts the call (assuming that system calls
  96 are not automatically restarted using the
  97 .B SA_RESTART
  98 flag of
  99 .BR sigaction (2)).
 100 In the remainder of this page, a child whose state has changed
 101 and which has not yet been waited upon by one of these system
 102 calls is termed
 103 .IR waitable .
 104 .SS "wait() and waitpid()"
 105 The
 106 .BR wait ()
 107 system call suspends execution of the calling process until one of its
 108 children terminates.
 109 The call
 110 .I wait(&status)
 111 is equivalent to:
 112 .nf
 113
 114     waitpid(\-1, &status, 0);
 115 .fi
 116
 117 The
 118 .BR waitpid ()
 119 system call suspends execution of the calling process until a
 120 child specified by
 121 .I pid
 122 argument has changed state.
 123 By default,
 124 .BR waitpid ()
 125 waits only for terminated children, but this behavior is modifiable
 126 via the
 127 .I options
 128 argument, as described below.
 129
 130 The value of
 131 .I pid
 132 can be:
 133 .IP "< \-1"
 134 meaning wait for any child process whose process group ID is
 135 equal to the absolute value of
 136 .IR pid .
 137 .IP \-1
 138 meaning wait for any child process.
 139 .IP 0
 140 meaning wait for any child process whose process group ID is
 141 equal to that of the calling process.
 142 .IP "> 0"
 143 meaning wait for the child whose process ID is equal to the
 144 value of
 145 .IR pid .
 146 .PP
 147 The value of
 148 .I options
 149 is an OR of zero or more of the following constants:
 150 .TP 12
 151 .B WNOHANG
 152 return immediately if no child has exited.
 153 .TP
 154 .B WUNTRACED
 155 also return if a child has stopped
 156 (but not traced via
 157 .BR ptrace (2)).
 158 Status for
 159 .I traced
 160 children which have stopped is provided
 161 even if this option is not specified.
 162 .TP
 163 .BR WCONTINUED " (since Linux 2.6.10)"
 164 also return if a stopped child has been resumed by delivery of
 165 .BR SIGCONT .
 166 .PP
 167 (For Linux-only options, see below.)
 168 .PP
 169 If
 170 .I status
 171 is not NULL,
 172 .BR wait ()
 173 and
 174 .BR waitpid ()
 175 store status information in the \fIint\fP to which it points.
 176 This integer can be inspected with the following macros (which
 177 take the integer itself as an argument, not a pointer to it,
 178 as is done in
 179 .BR wait ()
 180 and
 181 .BR waitpid ()!):
 182 .TP
 183 .BI WIFEXITED( status )
 184 returns true if the child terminated normally, that is,
 185 by calling
 186 .BR exit (3)
 187 or
 188 .BR _exit (2),
 189 or by returning from main().
 190 .TP
 191 .BI WEXITSTATUS( status )
 192 returns the exit status of the child.
 193 This consists of the least significant 8 bits of the
 194 .I status
 195 argument that the child specified in a call to
 196 .BR exit (3)
 197 or
 198 .BR _exit (2)
 199 or as the argument for a return statement in main().
 200 This macro should only be employed if
 201 .B WIFEXITED
 202 returned true.
 203 .TP
 204 .BI WIFSIGNALED( status )
 205 returns true if the child process was terminated by a signal.
 206 .TP
 207 .BI WTERMSIG( status )
 208 returns the number of the signal that caused the child process to
 209 terminate.
 210 This macro should only be employed if
 211 .B WIFSIGNALED
 212 returned true.
 213 .TP
 214 .BI WCOREDUMP( status )
 215 returns true if the child produced a core dump.
 216 This macro should only be employed if
 217 .B WIFSIGNALED
 218 returned true.
 219 This macro is not specified in POSIX.1-2001 and is not available on
 220 some UNIX implementations (e.g., AIX, SunOS).
 221 Only use this enclosed in #ifdef WCOREDUMP ... #endif.
 222 .TP
 223 .BI WIFSTOPPED( status )
 224 returns true if the child process was stopped by delivery of a signal;
 225 this is only possible if the call was done using
 226 .B WUNTRACED
 227 or when the child is being traced (see
 228 .BR ptrace (2)).
 229 .TP
 230 .BI WSTOPSIG( status )
 231 returns the number of the signal which caused the child to stop.
 232 This macro should only be employed if
 233 .B WIFSTOPPED
 234 returned true.
 235 .TP
 236 .BI WIFCONTINUED( status )
 237 (since Linux 2.6.10)
 238 returns true if the child process was resumed by delivery of
 239 .BR SIGCONT .
 240 .SS "waitid()"
 241 The
 242 .BR waitid ()
 243 system call (available since Linux 2.6.9) provides more precise
 244 control over which child state changes to wait for.
 245
 246 The
 247 .I idtype
 248 and
 249 .I id
 250 arguments select the child(ren) to wait for, as follows:
 251 .IP "\fIidtype\fP == \fBP_PID\fP"
 252 Wait for the child whose process ID matches
 253 .IR id .
 254 .IP "\fIidtype\fP == \fBP_PGID\fP"
 255 Wait for any child whose process group ID matches
 256 .IR id .
 257 .IP "\fIidtype\fP == \fBP_ALL\fP"
 258 Wait for any child;
 259 .I id
 260 is ignored.
 261 .PP
 262 The child state changes to wait for are specified by ORing
 263 one or more of the following flags in
 264 .IR options :
 265 .TP 12
 266 .B WEXITED
 267 Wait for children that have terminated.
 268 .TP
 269 .B WSTOPPED
 270 Wait for children that have been stopped by delivery of a signal.
 271 .TP
 272 .B WCONTINUED
 273 Wait for (previously stopped) children that have been
 274 resumed by delivery of
 275 .BR SIGCONT .
 276 .PP
 277 The following flags may additionally be ORed in
 278 .IR options :
 279 .TP 12
 280 .B WNOHANG
 281 As for
 282 .BR waitpid ().
 283 .TP
 284 .B WNOWAIT
 285 Leave the child in a waitable state; a later wait call
 286 can be used to again retrieve the child status information.
 287 .PP
 288 Upon successful return,
 289 .BR waitid ()
 290 fills in the following fields of the
 291 .I siginfo_t
 292 structure pointed to by
 293 .IR infop :
 294 .TP 12
 295 \fIsi_pid\fP
 296 The process ID of the child.
 297 .TP
 298 \fIsi_uid\fP
 299 The real user ID of the child.
 300 (This field is not set on most other implementations.)
 301 .TP
 302 \fIsi_signo\fP
 303 Always set to
 304 .BR SIGCHLD .
 305 .TP
 306 \fIsi_status\fP
 307 Either the exit status of the child, as given to
 308 .BR _exit (2)
 309 (or
 310 .BR exit (3)),
 311 or the signal that caused the child to terminate, stop, or continue.
 312 The
 313 .I si_code
 314 field can be used to determine how to interpret this field.
 315 .TP
 316 \fIsi_code\fP
 317 Set to one of:
 318 .B CLD_EXITED
 319 (child called
 320 .BR _exit (2));
 321 .B CLD_KILLED
 322 (child killed by signal);
 323 .B CLD_DUMPED
 324 (child killed by signal, and dumped core);
 325 .B CLD_STOPPED
 326 (child stopped by signal);
 327 .B CLD_TRAPPED
 328 (traced child has trapped); or
 329 .B CLD_CONTINUED
 330 (child continued by
 331 .BR SIGCONT ).
 332 .PP
 333 If
 334 .B WNOHANG
 335 was specified in
 336 .I options
 337 and there were no children in a waitable state, then
 338 .BR waitid ()
 339 returns 0 immediately and
 340 the state of the
 341 .I siginfo_t
 342 structure pointed to by
 343 .I infop
 344 is unspecified.
 345 .\" POSIX.1-2001 leaves this possibility unspecified; most
 346 .\" implementations (including Linux) zero out the structure
 347 .\" in this case, but at least one implementation (AIX 5.1)
 348 .\" does not -- MTK Nov 04
 349 To distinguish this case from that where a child was in a
 350 waitable state, zero out the
 351 .I si_pid
 352 field before the call and check for a nonzero value in this field
 353 after the call returns.
 354 .SH "RETURN VALUE"
 355 .BR wait ():
 356 on success, returns the process ID of the terminated child;
 357 on error, \-1 is returned.
 358
 359 .BR waitpid ():
 360 on success, returns the process ID of the child whose state has changed;
 361 if
 362 .B WNOHANG
 363 was specified and one or more child(ren) specified by
 364 .I pid
 365 exist, but have not yet changed state, then 0 is returned.
 366 On error, \-1 is returned.
 367
 368 .BR waitid ():
 369 returns 0 on success or
 370 if
 371 .B WNOHANG
 372 was specified and no child(ren) specified by
 373 .I id
 374 has yet changed state;
 375 on error, \-1 is returned.
 376 .\" FIXME: As reported by Vegard Nossum, if infop is NULL, then waitid()
 377 .\" returns the PID of the child.  Either this is a bug, or it is intended
 378 .\" behavior that needs to be documented.  See my Jan 2009 LKML mail
 379 .\" "waitid() return value strangeness when infop is NULL".
 380 Each of these calls sets
 381 .I errno
 382 to an appropriate value in the case of an error.
 383 .SH ERRORS
 384 .TP
 385 .B ECHILD
 386 (for
 387 .BR wait ())
 388 The calling process does not have any unwaited-for children.
 389 .TP
 390 .B ECHILD
 391 (for
 392 .BR waitpid ()
 393 or
 394 .BR waitid ())
 395 The process specified by
 396 .I pid
 397 .RB ( waitpid ())
 398 or
 399 .I idtype
 400 and
 401 .I id
 402 .RB ( waitid ())
 403 does not exist or is not a child of the calling process.
 404 (This can happen for one's own child if the action for
 405 .B SIGCHLD
 406 is set to
 407 .BR SIG_IGN .
 408 See also the \fILinux Notes\fP section about threads.)
 409 .TP
 410 .B EINTR
 411 .B WNOHANG
 412 was not set and an unblocked signal or a
 413 .B SIGCHLD
 414 was caught; see
 415 .BR signal (7).
 416 .TP
 417 .B EINVAL
 418 The
 419 .I options
 420 argument was invalid.
 421 .SH "CONFORMING TO"
 422 SVr4, 4.3BSD, POSIX.1-2001.
 423 .SH NOTES
 424 A child that terminates, but has not been waited for becomes a "zombie".
 425 The kernel maintains a minimal set of information about the zombie
 426 process (PID, termination status, resource usage information)
 427 in order to allow the parent to later perform a wait to obtain
 428 information about the child.
 429 As long as a zombie is not removed from the system via a wait,
 430 it will consume a slot in the kernel process table, and if
 431 this table fills, it will not be possible to create further processes.
 432 If a parent process terminates, then its "zombie" children (if any)
 433 are adopted by
 434 .BR init (8),
 435 which automatically performs a wait to remove the zombies.
 436
 437 POSIX.1-2001 specifies that if the disposition of
 438 .B SIGCHLD
 439 is set to
 440 .B SIG_IGN
 441 or the
 442 .B SA_NOCLDWAIT
 443 flag is set for
 444 .B SIGCHLD
 445 (see
 446 .BR sigaction (2)),
 447 then children that terminate do not become zombies and a call to
 448 .BR wait ()
 449 or
 450 .BR waitpid ()
 451 will block until all children have terminated, and then fail with
 452 .I errno
 453 set to
 454 .BR ECHILD .
 455 (The original POSIX standard left the behavior of setting
 456 .B SIGCHLD
 457 to
 458 .B SIG_IGN
 459 unspecified.
 460 Note that even though the default disposition of
 461 .B SIGCHLD
 462 is "ignore", explicitly setting the disposition to
 463 .B SIG_IGN
 464 results in different treatment of zombie process children.)
 465 Linux 2.6 conforms to this specification.
 466 However, Linux 2.4 (and earlier) does not:
 467 if a
 468 .BR wait ()
 469 or
 470 .BR waitpid ()
 471 call is made while
 472 .B SIGCHLD
 473 is being ignored, the call behaves just as though
 474 .B SIGCHLD
 475 were not being ignored, that is, the call blocks until the next child
 476 terminates and then returns the process ID and status of that child.
 477 .SS Linux Notes
 478 In the Linux kernel, a kernel-scheduled thread is not a distinct
 479 construct from a process.
 480 Instead, a thread is simply a process
 481 that is created using the Linux-unique
 482 .BR clone (2)
 483 system call; other routines such as the portable
 484 .BR pthread_create (3)
 485 call are implemented using
 486 .BR clone (2).
 487 Before Linux 2.4, a thread was just a special case of a process,
 488 and as a consequence one thread could not wait on the children
 489 of another thread, even when the latter belongs to the same thread group.
 490 However, POSIX prescribes such functionality, and since Linux 2.4
 491 a thread can, and by default will, wait on children of other threads
 492 in the same thread group.
 493 .LP
 494 The following Linux-specific
 495 .I options
 496 are for use with children created using
 497 .BR clone (2);
 498 they cannot be used with
 499 .BR waitid ():
 500 .TP
 501 .B __WCLONE
 502 .\" since 0.99pl10
 503 Wait for "clone" children only.
 504 If omitted then wait for "non-clone" children only.
 505 (A "clone" child is one which delivers no signal, or a signal other than
 506 .B SIGCHLD
 507 to its parent upon termination.)
 508 This option is ignored if
 509 .B __WALL
 510 is also specified.
 511 .TP
 512 .BR __WALL " (since Linux 2.4)"
 513 .\" since patch-2.3.48
 514 Wait for all children, regardless of
 515 type ("clone" or "non-clone").
 516 .TP
 517 .BR __WNOTHREAD " (since Linux 2.4)"
 518 .\" since patch-2.4.0-test8
 519 Do not wait for children of other threads in
 520 the same thread group.
 521 This was the default before Linux 2.4.
 522 .SH EXAMPLE
 523 .\" fork.2 refers to this example program.
 524 The following program demonstrates the use of
 525 .BR fork (2)
 526 and
 527 .BR waitpid ().
 528 The program creates a child process.
 529 If no command-line argument is supplied to the program,
 530 then the child suspends its execution using
 531 .BR pause (2),
 532 to allow the user to send signals to the child.
 533 Otherwise, if a command-line argument is supplied,
 534 then the child exits immediately,
 535 using the integer supplied on the command line as the exit status.
 536 The parent process executes a loop that monitors the child using
 537 .BR waitpid (),
 538 and uses the W*() macros described above to analyze the wait status value.
 539
 540 The following shell session demonstrates the use of the program:
 541 .in +4n
 542 .nf
 543
 544 .RB "$" " ./a.out &"
 545 Child PID is 32360
 546 [1] 32359
 547 .RB "$" " kill \-STOP 32360"
 548 stopped by signal 19
 549 .RB "$" " kill \-CONT 32360"
 550 continued
 551 .RB "$" " kill \-TERM 32360"
 552 killed by signal 15
 553 [1]+  Done                    ./a.out
 554 $
 555 .fi
 556 .in
 557 .SS Program source
 558 \&
 559 .nf
 560 #include <sys/wait.h>
 561 #include <stdlib.h>
 562 #include <unistd.h>
 563 #include <stdio.h>
 564
 565 int
 566 main(int argc, char *argv[])
 567 {
 568     pid_t cpid, w;
 569     int status;
 570
 571     cpid = fork();
 572     if (cpid == \-1) {
 573         perror("fork");
 574         exit(EXIT_FAILURE);
 575     }
 576
 577     if (cpid == 0) {            /* Code executed by child */
 578         printf("Child PID is %ld\\n", (long) getpid());
 579         if (argc == 1)
 580             pause();                    /* Wait for signals */
 581         _exit(atoi(argv[1]));
 582
 583     } else {                    /* Code executed by parent */
 584         do {
 585             w = waitpid(cpid, &status, WUNTRACED | WCONTINUED);
 586             if (w == \-1) {
 587                 perror("waitpid");
 588                 exit(EXIT_FAILURE);
 589             }
 590
 591             if (WIFEXITED(status)) {
 592                 printf("exited, status=%d\\n", WEXITSTATUS(status));
 593             } else if (WIFSIGNALED(status)) {
 594                 printf("killed by signal %d\\n", WTERMSIG(status));
 595             } else if (WIFSTOPPED(status)) {
 596                 printf("stopped by signal %d\\n", WSTOPSIG(status));
 597             } else if (WIFCONTINUED(status)) {
 598                 printf("continued\\n");
 599             }
 600         } while (!WIFEXITED(status) && !WIFSIGNALED(status));
 601         exit(EXIT_SUCCESS);
 602     }
 603 }
 604 .fi
 605 .SH "SEE ALSO"
 606 .BR _exit (2),
 607 .BR clone (2),
 608 .BR fork (2),
 609 .BR kill (2),
 610 .BR ptrace (2),
 611 .BR sigaction (2),
 612 .BR signal (2),
 613 .BR wait4 (2),
 614 .BR pthread_create (3),
 615 .BR credentials (7),
 616 .BR signal (7)