Remove old po/ code for copying .po files from shared directory.
[glibc.git] / manual / process.texi
blobb82b91f9f10f9086a7c70d66ee042f8a2831f859
1 @node Processes, Inter-Process Communication, Program Basics, Top
2 @c %MENU% How to create processes and run other programs
3 @chapter Processes
5 @cindex process
6 @dfn{Processes} are the primitive units for allocation of system
7 resources.  Each process has its own address space and (usually) one
8 thread of control.  A process executes a program; you can have multiple
9 processes executing the same program, but each process has its own copy
10 of the program within its own address space and executes it
11 independently of the other copies.
13 @cindex child process
14 @cindex parent process
15 Processes are organized hierarchically.  Each process has a @dfn{parent
16 process} which explicitly arranged to create it.  The processes created
17 by a given parent are called its @dfn{child processes}.  A child
18 inherits many of its attributes from the parent process.
20 This chapter describes how a program can create, terminate, and control
21 child processes.  Actually, there are three distinct operations
22 involved: creating a new child process, causing the new process to
23 execute a program, and coordinating the completion of the child process
24 with the original program.
26 The @code{system} function provides a simple, portable mechanism for
27 running another program; it does all three steps automatically.  If you
28 need more control over the details of how this is done, you can use the
29 primitive functions to do each step individually instead.
31 @menu
32 * Running a Command::           The easy way to run another program.
33 * Process Creation Concepts::   An overview of the hard way to do it.
34 * Process Identification::      How to get the process ID of a process.
35 * Creating a Process::          How to fork a child process.
36 * Executing a File::            How to make a process execute another program.
37 * Process Completion::          How to tell when a child process has completed.
38 * Process Completion Status::   How to interpret the status value
39                                  returned from a child process.
40 * BSD Wait Functions::          More functions, for backward compatibility.
41 * Process Creation Example::    A complete example program.
42 @end menu
45 @node Running a Command
46 @section Running a Command
47 @cindex running a command
49 The easy way to run another program is to use the @code{system}
50 function.  This function does all the work of running a subprogram, but
51 it doesn't give you much control over the details: you have to wait
52 until the subprogram terminates before you can do anything else.
54 @deftypefun int system (const char *@var{command})
55 @standards{ISO, stdlib.h}
56 @pindex sh
57 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuplugin{} @ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{}}}
58 @c system @ascuplugin @ascuheap @asulock @aculock @acsmem
59 @c  do_system @ascuplugin @ascuheap @asulock @aculock @acsmem
60 @c   sigemptyset dup ok
61 @c   libc_lock_lock @asulock @aculock
62 @c   ADD_REF ok
63 @c   sigaction dup ok
64 @c   SUB_REF ok
65 @c   libc_lock_unlock @aculock
66 @c   sigaddset dup ok
67 @c   sigprocmask dup ok
68 @c   CLEANUP_HANDLER @ascuplugin @ascuheap @acsmem
69 @c    libc_cleanup_region_start @ascuplugin @ascuheap @acsmem
70 @c     pthread_cleanup_push_defer @ascuplugin @ascuheap @acsmem
71 @c      CANCELLATION_P @ascuplugin @ascuheap @acsmem
72 @c       CANCEL_ENABLED_AND_CANCELED ok
73 @c       do_cancel @ascuplugin @ascuheap @acsmem
74 @c    cancel_handler ok
75 @c     kill syscall ok
76 @c     waitpid dup ok
77 @c     libc_lock_lock ok
78 @c     sigaction dup ok
79 @c     libc_lock_unlock ok
80 @c   FORK ok
81 @c    clone syscall ok
82 @c   waitpid dup ok
83 @c   CLEANUP_RESET ok
84 @c    libc_cleanup_region_end ok
85 @c     pthread_cleanup_pop_restore ok
86 @c  SINGLE_THREAD_P ok
87 @c  LIBC_CANCEL_ASYNC @ascuplugin @ascuheap @acsmem
88 @c   libc_enable_asynccancel @ascuplugin @ascuheap @acsmem
89 @c    CANCEL_ENABLED_AND_CANCELED_AND_ASYNCHRONOUS dup ok
90 @c    do_cancel dup @ascuplugin @ascuheap @acsmem
91 @c  LIBC_CANCEL_RESET ok
92 @c   libc_disable_asynccancel ok
93 @c    lll_futex_wait dup ok
94 This function executes @var{command} as a shell command.  In @theglibc{},
95 it always uses the default shell @code{sh} to run the command.
96 In particular, it searches the directories in @code{PATH} to find
97 programs to execute.  The return value is @code{-1} if it wasn't
98 possible to create the shell process, and otherwise is the status of the
99 shell process.  @xref{Process Completion}, for details on how this
100 status code can be interpreted.
102 If the @var{command} argument is a null pointer, a return value of zero
103 indicates that no command processor is available.
105 This function is a cancellation point in multi-threaded programs.  This
106 is a problem if the thread allocates some resources (like memory, file
107 descriptors, semaphores or whatever) at the time @code{system} is
108 called.  If the thread gets canceled these resources stay allocated
109 until the program ends.  To avoid this calls to @code{system} should be
110 protected using cancellation handlers.
111 @c ref pthread_cleanup_push / pthread_cleanup_pop
113 @pindex stdlib.h
114 The @code{system} function is declared in the header file
115 @file{stdlib.h}.
116 @end deftypefun
118 @strong{Portability Note:} Some C implementations may not have any
119 notion of a command processor that can execute other programs.  You can
120 determine whether a command processor exists by executing
121 @w{@code{system (NULL)}}; if the return value is nonzero, a command
122 processor is available.
124 The @code{popen} and @code{pclose} functions (@pxref{Pipe to a
125 Subprocess}) are closely related to the @code{system} function.  They
126 allow the parent process to communicate with the standard input and
127 output channels of the command being executed.
129 @node Process Creation Concepts
130 @section Process Creation Concepts
132 This section gives an overview of processes and of the steps involved in
133 creating a process and making it run another program.
135 @cindex process ID
136 @cindex process lifetime
137 Each process is named by a @dfn{process ID} number.  A unique process ID
138 is allocated to each process when it is created.  The @dfn{lifetime} of
139 a process ends when its termination is reported to its parent process;
140 at that time, all of the process resources, including its process ID,
141 are freed.
143 @cindex creating a process
144 @cindex forking a process
145 @cindex child process
146 @cindex parent process
147 Processes are created with the @code{fork} system call (so the operation
148 of creating a new process is sometimes called @dfn{forking} a process).
149 The @dfn{child process} created by @code{fork} is a copy of the original
150 @dfn{parent process}, except that it has its own process ID.
152 After forking a child process, both the parent and child processes
153 continue to execute normally.  If you want your program to wait for a
154 child process to finish executing before continuing, you must do this
155 explicitly after the fork operation, by calling @code{wait} or
156 @code{waitpid} (@pxref{Process Completion}).  These functions give you
157 limited information about why the child terminated---for example, its
158 exit status code.
160 A newly forked child process continues to execute the same program as
161 its parent process, at the point where the @code{fork} call returns.
162 You can use the return value from @code{fork} to tell whether the program
163 is running in the parent process or the child.
165 @cindex process image
166 Having several processes run the same program is only occasionally
167 useful.  But the child can execute another program using one of the
168 @code{exec} functions; see @ref{Executing a File}.  The program that the
169 process is executing is called its @dfn{process image}.  Starting
170 execution of a new program causes the process to forget all about its
171 previous process image; when the new program exits, the process exits
172 too, instead of returning to the previous process image.
174 @node Process Identification
175 @section Process Identification
177 The @code{pid_t} data type represents process IDs.  You can get the
178 process ID of a process by calling @code{getpid}.  The function
179 @code{getppid} returns the process ID of the parent of the current
180 process (this is also known as the @dfn{parent process ID}).  Your
181 program should include the header files @file{unistd.h} and
182 @file{sys/types.h} to use these functions.
183 @pindex sys/types.h
184 @pindex unistd.h
186 @deftp {Data Type} pid_t
187 @standards{POSIX.1, sys/types.h}
188 The @code{pid_t} data type is a signed integer type which is capable
189 of representing a process ID.  In @theglibc{}, this is an @code{int}.
190 @end deftp
192 @deftypefun pid_t getpid (void)
193 @standards{POSIX.1, unistd.h}
194 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
195 The @code{getpid} function returns the process ID of the current process.
196 @end deftypefun
198 @deftypefun pid_t getppid (void)
199 @standards{POSIX.1, unistd.h}
200 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
201 The @code{getppid} function returns the process ID of the parent of the
202 current process.
203 @end deftypefun
205 @node Creating a Process
206 @section Creating a Process
208 The @code{fork} function is the primitive for creating a process.
209 It is declared in the header file @file{unistd.h}.
210 @pindex unistd.h
212 @deftypefun pid_t fork (void)
213 @standards{POSIX.1, unistd.h}
214 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuplugin{}}@acunsafe{@aculock{}}}
215 @c The nptl/.../linux implementation safely collects fork_handlers into
216 @c an alloca()ed linked list and increments ref counters; it uses atomic
217 @c ops and retries, avoiding locking altogether.  It then takes the
218 @c IO_list lock, resets the thread-local pid, and runs fork.  The parent
219 @c restores the thread-local pid, releases the lock, and runs parent
220 @c handlers, decrementing the ref count and signaling futex wait if
221 @c requested by unregister_atfork.  The child bumps the fork generation,
222 @c sets the thread-local pid, resets cpu clocks, initializes the robust
223 @c mutex list, the stream locks, the IO_list lock, the dynamic loader
224 @c lock, runs the child handlers, reseting ref counters to 1, and
225 @c initializes the fork lock.  These are all safe, unless atfork
226 @c handlers themselves are unsafe.
227 The @code{fork} function creates a new process.
229 If the operation is successful, there are then both parent and child
230 processes and both see @code{fork} return, but with different values: it
231 returns a value of @code{0} in the child process and returns the child's
232 process ID in the parent process.
234 If process creation failed, @code{fork} returns a value of @code{-1} in
235 the parent process.  The following @code{errno} error conditions are
236 defined for @code{fork}:
238 @table @code
239 @item EAGAIN
240 There aren't enough system resources to create another process, or the
241 user already has too many processes running.  This means exceeding the
242 @code{RLIMIT_NPROC} resource limit, which can usually be increased;
243 @pxref{Limits on Resources}.
245 @item ENOMEM
246 The process requires more space than the system can supply.
247 @end table
248 @end deftypefun
250 The specific attributes of the child process that differ from the
251 parent process are:
253 @itemize @bullet
254 @item
255 The child process has its own unique process ID.
257 @item
258 The parent process ID of the child process is the process ID of its
259 parent process.
261 @item
262 The child process gets its own copies of the parent process's open file
263 descriptors.  Subsequently changing attributes of the file descriptors
264 in the parent process won't affect the file descriptors in the child,
265 and vice versa.  @xref{Control Operations}.  However, the file position
266 associated with each descriptor is shared by both processes;
267 @pxref{File Position}.
269 @item
270 The elapsed processor times for the child process are set to zero;
271 see @ref{Processor Time}.
273 @item
274 The child doesn't inherit file locks set by the parent process.
275 @c !!! flock locks shared
276 @xref{Control Operations}.
278 @item
279 The child doesn't inherit alarms set by the parent process.
280 @xref{Setting an Alarm}.
282 @item
283 The set of pending signals (@pxref{Delivery of Signal}) for the child
284 process is cleared.  (The child process inherits its mask of blocked
285 signals and signal actions from the parent process.)
286 @end itemize
289 @deftypefun pid_t vfork (void)
290 @standards{BSD, unistd.h}
291 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuplugin{}}@acunsafe{@aculock{}}}
292 @c The vfork implementation proper is a safe syscall, but it may fall
293 @c back to fork if the vfork syscall is not available.
294 The @code{vfork} function is similar to @code{fork} but on some systems
295 it is more efficient; however, there are restrictions you must follow to
296 use it safely.
298 While @code{fork} makes a complete copy of the calling process's address
299 space and allows both the parent and child to execute independently,
300 @code{vfork} does not make this copy.  Instead, the child process
301 created with @code{vfork} shares its parent's address space until it
302 calls @code{_exit} or one of the @code{exec} functions.  In the
303 meantime, the parent process suspends execution.
305 You must be very careful not to allow the child process created with
306 @code{vfork} to modify any global data or even local variables shared
307 with the parent.  Furthermore, the child process cannot return from (or
308 do a long jump out of) the function that called @code{vfork}!  This
309 would leave the parent process's control information very confused.  If
310 in doubt, use @code{fork} instead.
312 Some operating systems don't really implement @code{vfork}.  @Theglibc{}
313 permits you to use @code{vfork} on all systems, but actually
314 executes @code{fork} if @code{vfork} isn't available.  If you follow
315 the proper precautions for using @code{vfork}, your program will still
316 work even if the system uses @code{fork} instead.
317 @end deftypefun
319 @node Executing a File
320 @section Executing a File
321 @cindex executing a file
322 @cindex @code{exec} functions
324 This section describes the @code{exec} family of functions, for executing
325 a file as a process image.  You can use these functions to make a child
326 process execute a new program after it has been forked.
328 To see the effects of @code{exec} from the point of view of the called
329 program, see @ref{Program Basics}.
331 @pindex unistd.h
332 The functions in this family differ in how you specify the arguments,
333 but otherwise they all do the same thing.  They are declared in the
334 header file @file{unistd.h}.
336 @deftypefun int execv (const char *@var{filename}, char *const @var{argv}@t{[]})
337 @standards{POSIX.1, unistd.h}
338 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
339 The @code{execv} function executes the file named by @var{filename} as a
340 new process image.
342 The @var{argv} argument is an array of null-terminated strings that is
343 used to provide a value for the @code{argv} argument to the @code{main}
344 function of the program to be executed.  The last element of this array
345 must be a null pointer.  By convention, the first element of this array
346 is the file name of the program sans directory names.  @xref{Program
347 Arguments}, for full details on how programs can access these arguments.
349 The environment for the new process image is taken from the
350 @code{environ} variable of the current process image; see
351 @ref{Environment Variables}, for information about environments.
352 @end deftypefun
354 @deftypefun int execl (const char *@var{filename}, const char *@var{arg0}, @dots{})
355 @standards{POSIX.1, unistd.h}
356 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
357 This is similar to @code{execv}, but the @var{argv} strings are
358 specified individually instead of as an array.  A null pointer must be
359 passed as the last such argument.
360 @end deftypefun
362 @deftypefun int execve (const char *@var{filename}, char *const @var{argv}@t{[]}, char *const @var{env}@t{[]})
363 @standards{POSIX.1, unistd.h}
364 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
365 This is similar to @code{execv}, but permits you to specify the environment
366 for the new program explicitly as the @var{env} argument.  This should
367 be an array of strings in the same format as for the @code{environ}
368 variable; see @ref{Environment Access}.
369 @end deftypefun
371 @deftypefun int execle (const char *@var{filename}, const char *@var{arg0}, @dots{}, char *const @var{env}@t{[]})
372 @standards{POSIX.1, unistd.h}
373 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
374 This is similar to @code{execl}, but permits you to specify the
375 environment for the new program explicitly.  The environment argument is
376 passed following the null pointer that marks the last @var{argv}
377 argument, and should be an array of strings in the same format as for
378 the @code{environ} variable.
379 @end deftypefun
381 @deftypefun int execvp (const char *@var{filename}, char *const @var{argv}@t{[]})
382 @standards{POSIX.1, unistd.h}
383 @safety{@prelim{}@mtsafe{@mtsenv{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
384 The @code{execvp} function is similar to @code{execv}, except that it
385 searches the directories listed in the @code{PATH} environment variable
386 (@pxref{Standard Environment}) to find the full file name of a
387 file from @var{filename} if @var{filename} does not contain a slash.
389 This function is useful for executing system utility programs, because
390 it looks for them in the places that the user has chosen.  Shells use it
391 to run the commands that users type.
392 @end deftypefun
394 @deftypefun int execlp (const char *@var{filename}, const char *@var{arg0}, @dots{})
395 @standards{POSIX.1, unistd.h}
396 @safety{@prelim{}@mtsafe{@mtsenv{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
397 This function is like @code{execl}, except that it performs the same
398 file name searching as the @code{execvp} function.
399 @end deftypefun
401 The size of the argument list and environment list taken together must
402 not be greater than @code{ARG_MAX} bytes.  @xref{General Limits}.  On
403 @gnuhurdsystems{}, the size (which compares against @code{ARG_MAX})
404 includes, for each string, the number of characters in the string, plus
405 the size of a @code{char *}, plus one, rounded up to a multiple of the
406 size of a @code{char *}.  Other systems may have somewhat different
407 rules for counting.
409 These functions normally don't return, since execution of a new program
410 causes the currently executing program to go away completely.  A value
411 of @code{-1} is returned in the event of a failure.  In addition to the
412 usual file name errors (@pxref{File Name Errors}), the following
413 @code{errno} error conditions are defined for these functions:
415 @table @code
416 @item E2BIG
417 The combined size of the new program's argument list and environment
418 list is larger than @code{ARG_MAX} bytes.  @gnuhurdsystems{} have no
419 specific limit on the argument list size, so this error code cannot
420 result, but you may get @code{ENOMEM} instead if the arguments are too
421 big for available memory.
423 @item ENOEXEC
424 The specified file can't be executed because it isn't in the right format.
426 @item ENOMEM
427 Executing the specified file requires more storage than is available.
428 @end table
430 If execution of the new file succeeds, it updates the access time field
431 of the file as if the file had been read.  @xref{File Times}, for more
432 details about access times of files.
434 The point at which the file is closed again is not specified, but
435 is at some point before the process exits or before another process
436 image is executed.
438 Executing a new process image completely changes the contents of memory,
439 copying only the argument and environment strings to new locations.  But
440 many other attributes of the process are unchanged:
442 @itemize @bullet
443 @item
444 The process ID and the parent process ID.  @xref{Process Creation Concepts}.
446 @item
447 Session and process group membership.  @xref{Concepts of Job Control}.
449 @item
450 Real user ID and group ID, and supplementary group IDs.  @xref{Process
451 Persona}.
453 @item
454 Pending alarms.  @xref{Setting an Alarm}.
456 @item
457 Current working directory and root directory.  @xref{Working
458 Directory}.  On @gnuhurdsystems{}, the root directory is not copied when
459 executing a setuid program; instead the system default root directory
460 is used for the new program.
462 @item
463 File mode creation mask.  @xref{Setting Permissions}.
465 @item
466 Process signal mask; see @ref{Process Signal Mask}.
468 @item
469 Pending signals; see @ref{Blocking Signals}.
471 @item
472 Elapsed processor time associated with the process; see @ref{Processor Time}.
473 @end itemize
475 If the set-user-ID and set-group-ID mode bits of the process image file
476 are set, this affects the effective user ID and effective group ID
477 (respectively) of the process.  These concepts are discussed in detail
478 in @ref{Process Persona}.
480 Signals that are set to be ignored in the existing process image are
481 also set to be ignored in the new process image.  All other signals are
482 set to the default action in the new process image.  For more
483 information about signals, see @ref{Signal Handling}.
485 File descriptors open in the existing process image remain open in the
486 new process image, unless they have the @code{FD_CLOEXEC}
487 (close-on-exec) flag set.  The files that remain open inherit all
488 attributes of the open file descriptors from the existing process image,
489 including file locks.  File descriptors are discussed in @ref{Low-Level I/O}.
491 Streams, by contrast, cannot survive through @code{exec} functions,
492 because they are located in the memory of the process itself.  The new
493 process image has no streams except those it creates afresh.  Each of
494 the streams in the pre-@code{exec} process image has a descriptor inside
495 it, and these descriptors do survive through @code{exec} (provided that
496 they do not have @code{FD_CLOEXEC} set).  The new process image can
497 reconnect these to new streams using @code{fdopen} (@pxref{Descriptors
498 and Streams}).
500 @node Process Completion
501 @section Process Completion
502 @cindex process completion
503 @cindex waiting for completion of child process
504 @cindex testing exit status of child process
506 The functions described in this section are used to wait for a child
507 process to terminate or stop, and determine its status.  These functions
508 are declared in the header file @file{sys/wait.h}.
509 @pindex sys/wait.h
511 @deftypefun pid_t waitpid (pid_t @var{pid}, int *@var{status-ptr}, int @var{options})
512 @standards{POSIX.1, sys/wait.h}
513 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
514 The @code{waitpid} function is used to request status information from a
515 child process whose process ID is @var{pid}.  Normally, the calling
516 process is suspended until the child process makes status information
517 available by terminating.
519 Other values for the @var{pid} argument have special interpretations.  A
520 value of @code{-1} or @code{WAIT_ANY} requests status information for
521 any child process; a value of @code{0} or @code{WAIT_MYPGRP} requests
522 information for any child process in the same process group as the
523 calling process; and any other negative value @minus{} @var{pgid}
524 requests information for any child process whose process group ID is
525 @var{pgid}.
527 If status information for a child process is available immediately, this
528 function returns immediately without waiting.  If more than one eligible
529 child process has status information available, one of them is chosen
530 randomly, and its status is returned immediately.  To get the status
531 from the other eligible child processes, you need to call @code{waitpid}
532 again.
534 The @var{options} argument is a bit mask.  Its value should be the
535 bitwise OR (that is, the @samp{|} operator) of zero or more of the
536 @code{WNOHANG} and @code{WUNTRACED} flags.  You can use the
537 @code{WNOHANG} flag to indicate that the parent process shouldn't wait;
538 and the @code{WUNTRACED} flag to request status information from stopped
539 processes as well as processes that have terminated.
541 The status information from the child process is stored in the object
542 that @var{status-ptr} points to, unless @var{status-ptr} is a null pointer.
544 This function is a cancellation point in multi-threaded programs.  This
545 is a problem if the thread allocates some resources (like memory, file
546 descriptors, semaphores or whatever) at the time @code{waitpid} is
547 called.  If the thread gets canceled these resources stay allocated
548 until the program ends.  To avoid this calls to @code{waitpid} should be
549 protected using cancellation handlers.
550 @c ref pthread_cleanup_push / pthread_cleanup_pop
552 The return value is normally the process ID of the child process whose
553 status is reported.  If there are child processes but none of them is
554 waiting to be noticed, @code{waitpid} will block until one is.  However,
555 if the @code{WNOHANG} option was specified, @code{waitpid} will return
556 zero instead of blocking.
558 If a specific PID to wait for was given to @code{waitpid}, it will
559 ignore all other children (if any).  Therefore if there are children
560 waiting to be noticed but the child whose PID was specified is not one
561 of them, @code{waitpid} will block or return zero as described above.
563 A value of @code{-1} is returned in case of error.  The following
564 @code{errno} error conditions are defined for this function:
566 @table @code
567 @item EINTR
568 The function was interrupted by delivery of a signal to the calling
569 process.  @xref{Interrupted Primitives}.
571 @item ECHILD
572 There are no child processes to wait for, or the specified @var{pid}
573 is not a child of the calling process.
575 @item EINVAL
576 An invalid value was provided for the @var{options} argument.
577 @end table
578 @end deftypefun
580 These symbolic constants are defined as values for the @var{pid} argument
581 to the @code{waitpid} function.
583 @comment Extra blank lines make it look better.
584 @vtable @code
585 @item WAIT_ANY
587 This constant macro (whose value is @code{-1}) specifies that
588 @code{waitpid} should return status information about any child process.
591 @item WAIT_MYPGRP
592 This constant (with value @code{0}) specifies that @code{waitpid} should
593 return status information about any child process in the same process
594 group as the calling process.
595 @end vtable
597 These symbolic constants are defined as flags for the @var{options}
598 argument to the @code{waitpid} function.  You can bitwise-OR the flags
599 together to obtain a value to use as the argument.
601 @vtable @code
602 @item WNOHANG
604 This flag specifies that @code{waitpid} should return immediately
605 instead of waiting, if there is no child process ready to be noticed.
607 @item WUNTRACED
609 This flag specifies that @code{waitpid} should report the status of any
610 child processes that have been stopped as well as those that have
611 terminated.
612 @end vtable
614 @deftypefun pid_t wait (int *@var{status-ptr})
615 @standards{POSIX.1, sys/wait.h}
616 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
617 This is a simplified version of @code{waitpid}, and is used to wait
618 until any one child process terminates.  The call:
620 @smallexample
621 wait (&status)
622 @end smallexample
624 @noindent
625 is exactly equivalent to:
627 @smallexample
628 waitpid (-1, &status, 0)
629 @end smallexample
631 This function is a cancellation point in multi-threaded programs.  This
632 is a problem if the thread allocates some resources (like memory, file
633 descriptors, semaphores or whatever) at the time @code{wait} is
634 called.  If the thread gets canceled these resources stay allocated
635 until the program ends.  To avoid this calls to @code{wait} should be
636 protected using cancellation handlers.
637 @c ref pthread_cleanup_push / pthread_cleanup_pop
638 @end deftypefun
640 @deftypefun pid_t wait4 (pid_t @var{pid}, int *@var{status-ptr}, int @var{options}, struct rusage *@var{usage})
641 @standards{BSD, sys/wait.h}
642 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
643 If @var{usage} is a null pointer, @code{wait4} is equivalent to
644 @code{waitpid (@var{pid}, @var{status-ptr}, @var{options})}.
646 If @var{usage} is not null, @code{wait4} stores usage figures for the
647 child process in @code{*@var{rusage}} (but only if the child has
648 terminated, not if it has stopped).  @xref{Resource Usage}.
650 This function is a BSD extension.
651 @end deftypefun
653 Here's an example of how to use @code{waitpid} to get the status from
654 all child processes that have terminated, without ever waiting.  This
655 function is designed to be a handler for @code{SIGCHLD}, the signal that
656 indicates that at least one child process has terminated.
658 @smallexample
659 @group
660 void
661 sigchld_handler (int signum)
663   int pid, status, serrno;
664   serrno = errno;
665   while (1)
666     @{
667       pid = waitpid (WAIT_ANY, &status, WNOHANG);
668       if (pid < 0)
669         @{
670           perror ("waitpid");
671           break;
672         @}
673       if (pid == 0)
674         break;
675       notice_termination (pid, status);
676     @}
677   errno = serrno;
679 @end group
680 @end smallexample
682 @node Process Completion Status
683 @section Process Completion Status
685 If the exit status value (@pxref{Program Termination}) of the child
686 process is zero, then the status value reported by @code{waitpid} or
687 @code{wait} is also zero.  You can test for other kinds of information
688 encoded in the returned status value using the following macros.
689 These macros are defined in the header file @file{sys/wait.h}.
690 @pindex sys/wait.h
692 @deftypefn Macro int WIFEXITED (int @var{status})
693 @standards{POSIX.1, sys/wait.h}
694 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
695 This macro returns a nonzero value if the child process terminated
696 normally with @code{exit} or @code{_exit}.
697 @end deftypefn
699 @deftypefn Macro int WEXITSTATUS (int @var{status})
700 @standards{POSIX.1, sys/wait.h}
701 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
702 If @code{WIFEXITED} is true of @var{status}, this macro returns the
703 low-order 8 bits of the exit status value from the child process.
704 @xref{Exit Status}.
705 @end deftypefn
707 @deftypefn Macro int WIFSIGNALED (int @var{status})
708 @standards{POSIX.1, sys/wait.h}
709 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
710 This macro returns a nonzero value if the child process terminated
711 because it received a signal that was not handled.
712 @xref{Signal Handling}.
713 @end deftypefn
715 @deftypefn Macro int WTERMSIG (int @var{status})
716 @standards{POSIX.1, sys/wait.h}
717 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
718 If @code{WIFSIGNALED} is true of @var{status}, this macro returns the
719 signal number of the signal that terminated the child process.
720 @end deftypefn
722 @deftypefn Macro int WCOREDUMP (int @var{status})
723 @standards{BSD, sys/wait.h}
724 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
725 This macro returns a nonzero value if the child process terminated
726 and produced a core dump.
727 @end deftypefn
729 @deftypefn Macro int WIFSTOPPED (int @var{status})
730 @standards{POSIX.1, sys/wait.h}
731 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
732 This macro returns a nonzero value if the child process is stopped.
733 @end deftypefn
735 @deftypefn Macro int WSTOPSIG (int @var{status})
736 @standards{POSIX.1, sys/wait.h}
737 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
738 If @code{WIFSTOPPED} is true of @var{status}, this macro returns the
739 signal number of the signal that caused the child process to stop.
740 @end deftypefn
743 @node BSD Wait Functions
744 @section BSD Process Wait Function
746 @Theglibc{} also provides the @code{wait3} function for compatibility
747 with BSD.  This function is declared in @file{sys/wait.h}.  It is the
748 predecessor to @code{wait4}, which is more flexible.  @code{wait3} is
749 now obsolete.
750 @pindex sys/wait.h
752 @deftypefun pid_t wait3 (int *@var{status-ptr}, int @var{options}, struct rusage *@var{usage})
753 @standards{BSD, sys/wait.h}
754 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
755 If @var{usage} is a null pointer, @code{wait3} is equivalent to
756 @code{waitpid (-1, @var{status-ptr}, @var{options})}.
758 If @var{usage} is not null, @code{wait3} stores usage figures for the
759 child process in @code{*@var{rusage}} (but only if the child has
760 terminated, not if it has stopped).  @xref{Resource Usage}.
761 @end deftypefun
763 @node Process Creation Example
764 @section Process Creation Example
766 Here is an example program showing how you might write a function
767 similar to the built-in @code{system}.  It executes its @var{command}
768 argument using the equivalent of @samp{sh -c @var{command}}.
770 @smallexample
771 #include <stddef.h>
772 #include <stdlib.h>
773 #include <unistd.h>
774 #include <sys/types.h>
775 #include <sys/wait.h>
777 /* @r{Execute the command using this shell program.}  */
778 #define SHELL "/bin/sh"
780 @group
782 my_system (const char *command)
784   int status;
785   pid_t pid;
786 @end group
788   pid = fork ();
789   if (pid == 0)
790     @{
791       /* @r{This is the child process.  Execute the shell command.} */
792       execl (SHELL, SHELL, "-c", command, NULL);
793       _exit (EXIT_FAILURE);
794     @}
795   else if (pid < 0)
796     /* @r{The fork failed.  Report failure.}  */
797     status = -1;
798   else
799     /* @r{This is the parent process.  Wait for the child to complete.}  */
800     if (waitpid (pid, &status, 0) != pid)
801       status = -1;
802   return status;
804 @end smallexample
806 @comment Yes, this example has been tested.
808 There are a couple of things you should pay attention to in this
809 example.
811 Remember that the first @code{argv} argument supplied to the program
812 represents the name of the program being executed.  That is why, in the
813 call to @code{execl}, @code{SHELL} is supplied once to name the program
814 to execute and a second time to supply a value for @code{argv[0]}.
816 The @code{execl} call in the child process doesn't return if it is
817 successful.  If it fails, you must do something to make the child
818 process terminate.  Just returning a bad status code with @code{return}
819 would leave two processes running the original program.  Instead, the
820 right behavior is for the child process to report failure to its parent
821 process.
823 Call @code{_exit} to accomplish this.  The reason for using @code{_exit}
824 instead of @code{exit} is to avoid flushing fully buffered streams such
825 as @code{stdout}.  The buffers of these streams probably contain data
826 that was copied from the parent process by the @code{fork}, data that
827 will be output eventually by the parent process.  Calling @code{exit} in
828 the child would output the data twice.  @xref{Termination Internals}.