Miscellaneous corrections after 1st proofreading.
[kopensolaris-gnu/glibc.git] / manual / process.texi
1 @node Child Processes, Job Control, Process Startup, Top
2 @chapter Child Processes
3
4 @cindex process
5 @dfn{Processes} are the primitive units for allocation of system
6 resources.  Each process has its own address space and (usually) one
7 thread of control.  A process executes a program; you can have multiple
8 processes executing the same program, but each process has its own copy
9 of the program within its own address space and executes it
10 independently of the other copies.
11
12 @cindex child process
13 @cindex parent process
14 Processes are organized hierarchically.  Each process has a @dfn{parent
15 process} which explicitly arranged to create it.  The processes created
16 by a given parent are called its @dfn{child processes}.  A child
17 inherits many of its attributes from the parent process.
18
19 This chapter describes how a program can create, terminate, and control
20 child processes.  Actually, there are three distinct operations
21 involved: creating a new child process, causing the new process to
22 execute a program, and coordinating the completion of the child process
23 with the original program.
24
25 The @code{system} function provides a simple, portable mechanism for
26 running another program; it does all three steps automatically.  If you
27 need more control over the details of how this is done, you can use the
28 primitive functions to do each step individually instead.
29
30 @menu
31 * Running a Command::           The easy way to run another program.
32 * Process Creation Concepts::   An overview of the hard way to do it.
33 * Process Identification::      How to get the process ID of a process.
34 * Creating a Process::          How to fork a child process.
35 * Executing a File::            How to make a process execute another program.
36 * Process Completion::          How to tell when a child process has completed.
37 * Process Completion Status::   How to interpret the status value 
38                                  returned from a child process.
39 * BSD Wait Functions::          More functions, for backward compatibility.
40 * Process Creation Example::    A complete example program.
41 @end menu
42
43
44 @node Running a Command
45 @section Running a Command
46 @cindex running a command
47
48 The easy way to run another program is to use the @code{system}
49 function.  This function does all the work of running a subprogram, but
50 it doesn't give you much control over the details: you have to wait
51 until the subprogram terminates before you can do anything else.
52
53 @comment stdlib.h
54 @comment ANSI
55 @deftypefun int system (const char *@var{command})
56 @pindex sh
57 This function executes @var{command} as a shell command.  In the GNU C
58 library, it always uses the default shell @code{sh} to run the command.
59 In particular, it searches the directories in @code{PATH} to find
60 programs to execute.  The return value is @code{-1} if it wasn't
61 possible to create the shell process, and otherwise is the status of the
62 shell process.  @xref{Process Completion}, for details on how this
63 status code can be interpreted.
64
65 @pindex stdlib.h
66 The @code{system} function is declared in the header file
67 @file{stdlib.h}.
68 @end deftypefun
69
70 @strong{Portability Note:} Some C implementations may not have any
71 notion of a command processor that can execute other programs.  You can
72 determine whether a command processor exists by executing
73 @w{@code{system (NULL)}}; if the return value is nonzero, a command
74 processor is available.
75
76 The @code{popen} and @code{pclose} functions (@pxref{Pipe to a
77 Subprocess}) are closely related to the @code{system} function.  They
78 allow the parent process to communicate with the standard input and
79 output channels of the command being executed.
80
81 @node Process Creation Concepts
82 @section Process Creation Concepts
83
84 This section gives an overview of processes and of the steps involved in
85 creating a process and making it run another program.
86
87 @cindex process ID
88 @cindex process lifetime
89 Each process is named by a @dfn{process ID} number.  A unique process ID
90 is allocated to each process when it is created.  The @dfn{lifetime} of
91 a process ends when its termination is reported to its parent process;
92 at that time, all of the process resources, including its process ID,
93 are freed.
94
95 @cindex creating a process
96 @cindex forking a process
97 @cindex child process
98 @cindex parent process
99 Processes are created with the @code{fork} system call (so the operation
100 of creating a new process is sometimes called @dfn{forking} a process).
101 The @dfn{child process} created by @code{fork} is an exact clone of the
102 original @dfn{parent process}, except that it has its own process ID.
103
104 After forking a child process, both the parent and child processes
105 continue to execute normally.  If you want your program to wait for a
106 child process to finish executing before continuing, you must do this
107 explicitly after the fork operation, by calling @code{wait} or
108 @code{waitpid} (@pxref{Process Completion}).  These functions give you
109 limited information about why the child terminated---for example, its
110 exit status code.
111
112 A newly forked child process continues to execute the same program as
113 its parent process, at the point where the @code{fork} call returns.
114 You can use the return value from @code{fork} to tell whether the program
115 is running in the parent process or the child.
116
117 @cindex process image
118 Having several processes run the same program is only occasionally
119 useful.  But the child can execute another program using one of the
120 @code{exec} functions; see @ref{Executing a File}.  The program that the
121 process is executing is called its @dfn{process image}.  Starting
122 execution of a new program causes the process to forget all about its
123 previous process image; when the new program exits, the process exits
124 too, instead of returning to the previous process image.
125
126 @node Process Identification
127 @section Process Identification
128
129 The @code{pid_t} data type represents process IDs.  You can get the
130 process ID of a process by calling @code{getpid}.  The function
131 @code{getppid} returns the process ID of the parent of the current
132 process (this is also known as the @dfn{parent process ID}).  Your
133 program should include the header files @file{unistd.h} and
134 @file{sys/types.h} to use these functions.
135 @pindex sys/types.h
136 @pindex unistd.h
137
138 @comment sys/types.h
139 @comment POSIX.1
140 @deftp {Data Type} pid_t
141 The @code{pid_t} data type is a signed integer type which is capable
142 of representing a process ID.  In the GNU library, this is an @code{int}.
143 @end deftp
144
145 @comment unistd.h
146 @comment POSIX.1
147 @deftypefun pid_t getpid (void)
148 The @code{getpid} function returns the process ID of the current process.
149 @end deftypefun
150
151 @comment unistd.h
152 @comment POSIX.1
153 @deftypefun pid_t getppid (void)
154 The @code{getppid} function returns the process ID of the parent of the
155 current process.
156 @end deftypefun
157
158 @node Creating a Process
159 @section Creating a Process
160
161 The @code{fork} function is the primitive for creating a process.
162 It is declared in the header file @file{unistd.h}.
163 @pindex unistd.h
164
165 @comment unistd.h
166 @comment POSIX.1
167 @deftypefun pid_t fork (void)
168 The @code{fork} function creates a new process.
169
170 If the operation is successful, there are then both parent and child
171 processes and both see @code{fork} return, but with different values: it
172 returns a value of @code{0} in the child process and returns the child's
173 process ID in the parent process.
174
175 If process creation failed, @code{fork} returns a value of @code{-1} in
176 the parent process.  The following @code{errno} error conditions are
177 defined for @code{fork}:
178
179 @table @code
180 @item EAGAIN
181 There aren't enough system resources to create another process, or the
182 user already has too many processes running.
183
184 @item ENOMEM
185 The process requires more space than the system can supply.
186 @end table
187 @end deftypefun
188
189 The specific attributes of the child process that differ from the
190 parent process are:
191
192 @itemize @bullet
193 @item
194 The child process has its own unique process ID.
195
196 @item
197 The parent process ID of the child process is the process ID of its
198 parent process.
199
200 @item
201 The child process gets its own copies of the parent process's open file
202 descriptors.  Subsequently changing attributes of the file descriptors
203 in the parent process won't affect the file descriptors in the child,
204 and vice versa.  @xref{Control Operations}.
205
206 @item
207 The elapsed processor times for the child process are set to zero;
208 see @ref{Processor Time}.
209
210 @item
211 The child doesn't inherit file locks set by the parent process.
212 @xref{Control Operations}.
213
214 @item
215 The child doesn't inherit alarms set by the parent process.
216 @xref{Setting an Alarm}.
217
218 @item
219 The set of pending signals (@pxref{Delivery of Signal}) for the child
220 process is cleared.  (The child process inherits its mask of blocked
221 signals and signal actions from the parent process.)
222 @end itemize 
223
224
225 @comment unistd.h
226 @comment BSD
227 @deftypefun pid_t vfork (void)
228 The @code{vfork} function is similar to @code{fork} but more efficient;
229 however, there are restrictions you must follow to use it safely.
230
231 While @code{fork} makes a complete copy of the calling process's address
232 space and allows both the parent and child to execute independently,
233 @code{vfork} does not make this copy.  Instead, the child process
234 created with @code{vfork} shares its parent's address space until it calls
235 one of the @code{exec} functions.  In the meantime, the parent process
236 suspends execution.
237
238 You must be very careful not to allow the child process created with
239 @code{vfork} to modify any global data or even local variables shared
240 with the parent.  Furthermore, the child process cannot return from (or
241 do a long jump out of) the function that called @code{vfork}!  This
242 would leave the parent process's control information very confused.  If
243 in doubt, use @code{fork} instead.
244
245 Some operating systems don't really implement @code{vfork}.  The GNU C
246 library permits you to use @code{vfork} on all systems, but actually
247 executes @code{fork} if @code{vfork} isn't available.  If you follow
248 the proper precautions for using @code{vfork}, your program will still
249 work even if the system uses @code{fork} instead.
250 @end deftypefun
251
252 @node Executing a File
253 @section Executing a File
254 @cindex executing a file
255 @cindex @code{exec} functions
256
257 This section describes the @code{exec} family of functions, for executing
258 a file as a process image.  You can use these functions to make a child
259 process execute a new program after it has been forked.
260
261 @pindex unistd.h
262 The functions in this family differ in how you specify the arguments,
263 but otherwise they all do the same thing.  They are declared in the
264 header file @file{unistd.h}.
265
266 @comment unistd.h
267 @comment POSIX.1
268 @deftypefun int execv (const char *@var{filename}, char *const @var{argv}@t{[]})
269 The @code{execv} function executes the file named by @var{filename} as a
270 new process image.
271
272 The @var{argv} argument is an array of null-terminated strings that is
273 used to provide a value for the @code{argv} argument to the @code{main}
274 function of the program to be executed.  The last element of this array
275 must be a null pointer.  @xref{Program Arguments}, for information on
276 how programs can access these arguments.
277
278 The environment for the new process image is taken from the
279 @code{environ} variable of the current process image; see @ref{Environment
280 Variables}, for information about environments.
281 @end deftypefun
282
283 @comment unistd.h
284 @comment POSIX.1
285 @deftypefun int execl (const char *@var{filename}, const char *@var{arg0}, @dots{})
286 This is similar to @code{execv}, but the @var{argv} strings are
287 specified individually instead of as an array.  A null pointer must be
288 passed as the last such argument.
289 @end deftypefun
290
291 @comment unistd.h
292 @comment POSIX.1
293 @deftypefun int execve (const char *@var{filename}, char *const @var{argv}@t{[]}, char *const @var{env}@t{[]})
294 This is similar to @code{execv}, but permits you to specify the environment
295 for the new program explicitly as the @var{env} argument.  This should
296 be an array of strings in the same format as for the @code{environ} 
297 variable; see @ref{Environment Access}.
298 @end deftypefun
299
300 @comment unistd.h
301 @comment POSIX.1
302 @deftypefun int execle (const char *@var{filename}, const char *@var{arg0}, char *const @var{env}@t{[]}, @dots{})
303 This is similar to @code{execl}, but permits you to specify the
304 environment for the new program explicitly.  The environment argument is
305 passed following the null pointer that marks the last @var{argv}
306 argument, and should be an array of strings in the same format as for
307 the @code{environ} variable.
308 @end deftypefun
309
310 @comment unistd.h
311 @comment POSIX.1
312 @deftypefun int execvp (const char *@var{filename}, char *const @var{argv}@t{[]})
313 The @code{execvp} function is similar to @code{execv}, except that it
314 searches the directories listed in the @code{PATH} environment variable
315 (@pxref{Standard Environment}) to find the full file name of a
316 file from @var{filename} if @var{filename} does not contain a slash.
317
318 This function is useful for executing system utility programs, because
319 it looks for them in the places that the user has chosen.  Shells use it
320 to run the commands that users type.
321 @end deftypefun
322
323 @comment unistd.h
324 @comment POSIX.1
325 @deftypefun int execlp (const char *@var{filename}, const char *@var{arg0}, @dots{})
326 This function is like @code{execl}, except that it performs the same
327 file name searching as the @code{execvp} function.
328 @end deftypefun
329
330 The size of the argument list and environment list taken together must
331 not be greater than @code{ARG_MAX} bytes.  @xref{General Limits}.  In
332 the GNU system, the size (which compares against @code{ARG_MAX})
333 includes, for each string, the number of characters in the string, plus
334 the size of a @code{char *}, plus one, rounded up to a multiple of' the
335 size of a @code{char *}.  Other systems may have somewhat different
336 rules for counting.
337
338 These functions normally don't return, since execution of a new program
339 causes the currently executing program to go away completely.  A value
340 of @code{-1} is returned in the event of a failure.  In addition to the
341 usual file name syntax errors (@pxref{File Name Errors}), the following
342 @code{errno} error conditions are defined for these functions:
343
344 @table @code
345 @item E2BIG
346 The combined size of the new program's argument list and environment list
347 is larger than @code{ARG_MAX} bytes.
348 @c !!! never in GNU; ARG_MAX is unlimited.  Get ENOMEM instead if too big.
349
350 @item ENOEXEC
351 The specified file can't be executed because it isn't in the right format.
352
353 @item ENOMEM
354 Executing the specified file requires more storage than is available.
355 @end table
356
357 If execution of the new file succeeds, it updates the access time field
358 of the file as if the file had been read.  @xref{File Times}, for more
359 details about access times of files.
360
361 The point at which the file is closed again is not specified, but
362 is at some point before the process exits or before another process
363 image is executed.
364
365 @c !!! this paragraph suggests that argv and envp keep their addressses
366 @c in the new program, which is not true.
367 Executing a new process image completely changes the contents of memory,
368 except for the arguments and the environment, but many other attributes
369 of the process are unchanged:
370
371 @itemize @bullet
372 @item
373 The process ID and the parent process ID.  @xref{Process Creation Concepts}.
374
375 @item
376 Session and process group membership.  @xref{Concepts of Job Control}.
377
378 @item
379 Real user ID and group ID, and supplementary group IDs.  @xref{Process
380 Persona}.
381
382 @item
383 Pending alarms.  @xref{Setting an Alarm}.
384
385 @item
386 Current working directory and root directory.  @xref{Working Directory}.
387
388 @item
389 File mode creation mask.  @xref{Setting Permissions}.
390
391 @item
392 Process signal mask; see @ref{Process Signal Mask}.
393
394 @item
395 Pending signals; see @ref{Blocking Signals}.
396
397 @item
398 Elapsed processor time associated with the process; see @ref{Processor Time}.
399 @end itemize
400
401 If the set-user-ID and set-group-ID mode bits of the process image file
402 are set, this affects the effective user ID and effective group ID
403 (respectively) of the process.  These concepts are discussed in detail
404 in @ref{Process Persona}.
405
406 Signals that are set to be ignored in the existing process image are
407 also set to be ignored in the new process image.  All other signals are
408 set to the default action in the new process image.  For more
409 information about signals, see @ref{Signal Handling}.
410
411 File descriptors open in the existing process image remain open in the
412 new process image, unless they have the @code{FD_CLOEXEC}
413 (close-on-exec) flag set.  The files that remain open inherit all
414 attributes of the open file description from the existing process image,
415 including file locks.  File descriptors are discussed in @ref{Low-Level I/O}.
416
417 Streams, by contrast, cannot survive through @code{exec} functions,
418 because they are located in the memory of the process itself.  The new
419 process image has no streams except those it creates afresh.  Each of
420 the streams in the pre-@code{exec} process image has a descriptor inside
421 it, and these descriptors do survive through @code{exec} (provided that
422 they do not have @code{FD_CLOEXEC} set.  The new process image can
423 reconnect these to new streams using @code{fdopen} (@pxref{Descriptors
424 and Streams}).
425 @c !!! this is a bad thing to recommend.  it won't work in GNU, where
426 @c fopen doesn't go thru a file descriptor.
427
428 @node Process Completion
429 @section Process Completion
430 @cindex process completion
431 @cindex waiting for completion of child process
432 @cindex testing exit status of child process
433
434 The functions described in this section are used to wait for a child
435 process to terminate or stop, and determine its status.  These functions
436 are declared in the header file @file{sys/wait.h}.
437 @pindex sys/wait.h
438
439 @comment sys/wait.h
440 @comment POSIX.1
441 @deftypefun pid_t waitpid (pid_t @var{pid}, int *@var{status_ptr}, int @var{options})
442 The @code{waitpid} function is used to request status information from a
443 child process whose process ID is @var{pid}.  Normally, the calling
444 process is suspended until the child process makes status information
445 available by terminating.
446
447 Other values for the @var{pid} argument have special interpretations.  A
448 value of @code{-1} or @code{WAIT_ANY} requests status information for
449 any child process; a value of @code{0} or @code{WAIT_MYPGRP} requests
450 information for any child process in the same process group as the
451 calling process; and any other negative value @minus{} @var{pgid}
452 requests information for any child process whose process group ID is
453 @var{pgid}.
454
455 If status information for a child process is available immediately, this
456 function returns immediately without waiting.  If more than one eligible
457 child process has status information available, one of them is chosen
458 randomly, and its status is returned immediately.  To get the status
459 from the other eligible child processes, you need to call @code{waitpid}
460 again.
461
462 The @var{options} argument is a bit mask.  Its value should be the
463 bitwise OR (that is, the @samp{|} operator) of zero or more of the
464 @code{WNOHANG} and @code{WUNTRACED} flags.  You can use the
465 @code{WNOHANG} flag to indicate that the parent process shouldn't wait;
466 and the @code{WUNTRACED} flag to request status information from stopped
467 processes as well as processes that have terminated.
468
469 The status information from the child process is stored in the object
470 that @var{status_ptr} points to, unless @var{status_ptr} is a null pointer.
471
472 The return value is normally the process ID of the child process whose
473 status is reported.  If the @code{WNOHANG} option was specified and no
474 child process is waiting to be noticed, the value is zero.  A value of
475 @code{-1} is returned in case of error.  The following @code{errno}
476 error conditions are defined for this function:
477
478 @table @code
479 @item EINTR
480 The function was interrupted by delivery of a signal to the calling
481 process.  @xref{Interrupted Primitives}.
482
483 @item ECHILD
484 There are no child processes to wait for, or the specified @var{pid}
485 is not a child of the calling process.
486
487 @item EINVAL
488 An invalid value was provided for the @var{options} argument.
489 @end table
490 @end deftypefun
491
492 These symbolic constants are defined as values for the @var{pid} argument
493 to the @code{waitpid} function.
494
495 @comment Extra blank lines make it look better.
496 @table @code
497 @item WAIT_ANY
498
499 This constant macro (whose value is @code{-1}) specifies that
500 @code{waitpid} should return status information about any child process.
501
502
503 @item WAIT_MYPGRP
504 This constant (with value @code{0}) specifies that @code{waitpid} should
505 return status information about any child process in the same process
506 group as the calling process.
507 @end table
508
509 These symbolic constants are defined as flags for the @var{options}
510 argument to the @code{waitpid} function.  You can bitwise-OR the flags
511 together to obtain a value to use as the argument.
512
513 @table @code
514 @item WNOHANG
515
516 This flag specifies that @code{waitpid} should return immediately
517 instead of waiting, if there is no child process ready to be noticed.
518
519 @item WUNTRACED
520
521 This flag specifies that @code{waitpid} should report the status of any
522 child processes that have been stopped as well as those that have
523 terminated.
524 @end table
525
526 @comment sys/wait.h
527 @comment POSIX.1
528 @deftypefun pid_t wait (int *@var{status_ptr})
529 This is a simplified version of @code{waitpid}, and is used to wait
530 until any one child process terminates.
531
532 @example
533 wait (&status)
534 @end example
535
536 @noindent
537 is equivalent to:
538
539 @example
540 waitpid (-1, &status, 0)
541 @end example
542 @end deftypefun
543
544 Here's an example of how to use @code{waitpid} to get the status from
545 all child processes that have terminated, without ever waiting.  This
546 function is designed to be a handler for @code{SIGCHLD}, the signal that
547 indicates that at least one child process has terminated.
548
549 @example
550 @group
551 void
552 sigchld_handler (int signum)
553 @{
554   int pid;
555   int status;
556   while (1) @{
557     pid = waitpid (WAIT_ANY, &status, WNOHANG);
558     if (pid < 0) @{
559       perror ("waitpid");
560       break;
561     @}
562     if (pid == 0)
563       break;
564     notice_termination (pid, status);
565   @}
566 @}
567 @end group
568 @end example
569
570 @node Process Completion Status
571 @section Process Completion Status
572
573 If the exit status value (@pxref{Program Termination}) of the child
574 process is zero, then the status value reported by @code{waitpid} or
575 @code{wait} is also zero.  You can test for other kinds of information
576 encoded in the returned status value using the following macros.
577 These macros are defined in the header file @file{sys/wait.h}.
578 @pindex sys/wait.h
579
580 @comment sys/wait.h
581 @comment POSIX.1
582 @deftypefn Macro int WIFEXITED (int @var{status})
583 This macro returns a non-zero value if the child process terminated
584 normally with @code{exit} or @code{_exit}.
585 @end deftypefn
586
587 @comment sys/wait.h
588 @comment POSIX.1
589 @deftypefn Macro int WEXITSTATUS (int @var{status})
590 If @code{WIFEXITED} is true of @var{status}, this macro returns the
591 low-order 8 bits of the exit status value from the child process.
592 @xref{Exit Status}.
593 @end deftypefn
594
595 @comment sys/wait.h
596 @comment POSIX.1
597 @deftypefn Macro int WIFSIGNALED (int @var{status})
598 This macro returns a non-zero value if the child process terminated
599 because it received a signal that was not handled.
600 @xref{Signal Handling}.
601 @end deftypefn
602
603 @comment sys/wait.h
604 @comment POSIX.1
605 @deftypefn Macro int WTERMSIG (int @var{status})
606 If @code{WIFSIGNALED} is true of @var{status}, this macro returns the
607 signal number of the signal that terminated the child process.
608 @end deftypefn
609
610 @comment sys/wait.h
611 @comment BSD
612 @deftypefn Macro int WCOREDUMP (int @var{status})
613 This macro returns a non-zero value if the child process terminated
614 and produced a core dump.
615 @end deftypefn
616
617 @comment sys/wait.h
618 @comment POSIX.1
619 @deftypefn Macro int WIFSTOPPED (int @var{status})
620 This macro returns a non-zero value if the child process is stopped.
621 @end deftypefn
622
623 @comment sys/wait.h
624 @comment POSIX.1
625 @deftypefn Macro int WSTOPSIG (int @var{status})
626 If @code{WIFSTOPPED} is true of @var{status}, this macro returns the
627 signal number of the signal that caused the child process to stop.
628 @end deftypefn
629
630
631 @node BSD Wait Functions
632 @section BSD Process Wait Functions
633
634 The GNU library also provides these related facilities for compatibility
635 with BSD Unix.  BSD uses the @code{union wait} data type to represent
636 status values rather than an @code{int}.  The two representations are
637 actually interchangeable; they describe the same bit patterns.  The GNU
638 C Library defines macros such as @code{WEXITSTATUS} so that they will
639 work on either kind of object, and the @code{wait} function is defined
640 to accept either type of pointer as its @var{status_ptr} argument.
641
642 These functions are declared in @file{sys/wait.h}.
643 @pindex sys/wait.h
644
645 @comment sys/wait.h
646 @comment BSD
647 @deftp {Data Type} {union wait}
648 This data type represents program termination status values.  It has
649 the following members:
650
651 @table @code
652 @item int w_termsig
653 This member is equivalent to the @code{WTERMSIG} macro.
654
655 @item int w_coredump
656 This member is equivalent to the @code{WCOREDUMP} macro.
657
658 @item int w_retcode
659 This member is equivalent to the @code{WEXISTATUS} macro.
660
661 @item int w_stopsig
662 This member is equivalent to the @code{WSTOPSIG} macro.
663 @end table
664
665 Instead of accessing these members directly, you should use the
666 equivalent macros.
667 @end deftp
668
669 @comment sys/wait.h
670 @comment BSD
671 @deftypefun pid_t wait3 (union wait *@var{status_ptr}, int @var{options}, struct rusage *@var{usage})
672 If @var{usage} is a null pointer, this function is equivalent to
673 @w{@code{waitpid (-1, @var{status_ptr}, @var{options})}}.
674
675 If @var{usage} is not null, @code{wait4} stores usage figures for the
676 child process in @code{*@var{rusage}} (but only if the child has
677 terminated, not if it has stopped).  @xref{Resource Usage}.
678 @end deftypefun
679
680 @comment sys/wait.h
681 @comment BSD
682 @deftypefun pid_t wait4 (pid_t @var{pid}, union wait *@var{status_ptr}, int @var{options}, struct rusage *@var{usage})
683 If @var{usage} is a null pointer, this function is equivalent to
684 @w{@code{waitpid (@var{pid}, @var{status_ptr}, @var{options})}}.
685
686 If @var{usage} is not null, @code{wait4} stores usage figures for the
687 child process in @code{*@var{rusage}} (but only if the child has
688 terminated, not if it has stopped).  @xref{Resource Usage}.
689 @end deftypefun
690
691 @node Process Creation Example
692 @section Process Creation Example
693
694 Here is an example program showing how you might write a function
695 similar to the built-in @code{system}.  It executes its @var{command}
696 argument using the equivalent of @samp{sh -c @var{command}}.
697
698 @example
699 #include <stddef.h>
700 #include <stdlib.h>
701 #include <unistd.h>
702 #include <sys/types.h>
703 #include <sys/wait.h>
704
705 /* @r{Execute the command using this shell program.}  */
706 #define SHELL "/bin/sh"
707
708 @group
709 int 
710 my_system (const char *command)
711 @{
712   int status;
713   pid_t pid;
714 @end group
715
716   pid = fork ();
717   if (pid == 0)
718     @{
719       /* @r{This is the child process.  Execute the shell command.} */
720       execl (SHELL, SHELL, "-c", command, NULL);
721       _exit (EXIT_FAILURE);
722     @}
723   else if (pid < 0)
724     /* @r{The fork failed.  Report failure.}  */
725     status = -1;
726   else
727     /* @r{This is the parent process.  Wait for the child to complete.}  */
728     if (waitpid (pid, &status, 0) != pid)
729       status = -1;
730   return status;
731 @}
732 @end example
733
734 @comment Yes, this example has been tested.
735
736 There are a couple of things you should pay attention to in this
737 example.
738
739 Remember that the first @code{argv} argument supplied to the program
740 represents the name of the program being executed.  That is why, in the
741 call to @code{execl}, @code{SHELL} is supplied once to name the program
742 to execute and a second time to supply a value for @code{argv[0]}.  
743
744 The @code{execl} call in the child process doesn't return if it is
745 successful.  If it fails, you must do something to make the child
746 process terminate.  Just returning a bad status code with @code{return}
747 would leave two processes running the original program.  Instead, the
748 right behavior is for the child process to report failure to its parent
749 process.  Calling @code{exit} accomplishes this.
750
751 @c !!! you want to call _exit instead, to avoid lossage from duplicated
752 @c stdio buffers after fork.  explain this situation.